From 91995975521849a7a35921f7bbc25397eed78d52 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sun, 6 Oct 2024 19:49:26 -0700
Subject: Convert nng_random to new format.

---
 docs/ref/api/util/index.md      |  6 ++++++
 docs/ref/api/util/nng_random.md | 25 +++++++++++++++++++++++++
 2 files changed, 31 insertions(+)
 create mode 100644 docs/ref/api/util/nng_random.md

(limited to 'docs/ref/api/util')

diff --git a/docs/ref/api/util/index.md b/docs/ref/api/util/index.md
index 9f155b65..e11692c6 100644
--- a/docs/ref/api/util/index.md
+++ b/docs/ref/api/util/index.md
@@ -1,5 +1,11 @@
 # Utility Functions
 
+This section documents various utility functions that may help
+with application portability. These are not fundamental to NNG
+or Scalability Protocols, but we find them useful for a variety
+of other uses.
+
 - [nng_clock](nng_clock.md)
 - [nng_id_map](nng_id_map.md)
 - [nng_msleep](nng_msleep.md)
+- [nng_random](nng_random.md)
diff --git a/docs/ref/api/util/nng_random.md b/docs/ref/api/util/nng_random.md
new file mode 100644
index 00000000..160752ab
--- /dev/null
+++ b/docs/ref/api/util/nng_random.md
@@ -0,0 +1,25 @@
+# nng_random
+
+## NAME
+
+nng_random --- get random number
+
+## SYNOPSIS
+
+```c
+#include <nng/nng.h>
+
+uint32_t nng_random(void);
+```
+
+## DESCRIPTION
+
+The `nng_random` returns a random number.
+The value returned is suitable for use with cryptographic functions such as
+key generation.
+The value is obtained using platform-specific cryptographically strong random
+number facilities when available.
+
+## RETURN VALUES
+
+Returns a random 32-bit value.
-- 
cgit v1.2.3-70-g09d2