From 9a90ac1a85abeebf3435d9be0895fbd63c65b544 Mon Sep 17 00:00:00 2001
From: ENGO150 <v.smejkal06@gmail.com>
Date: Sat, 25 Jan 2025 15:30:54 +0100
Subject: [PATCH] created doc for why2_seeded_random

---
 .../core/crypto/why2_seeded_random.md         | 35 +++++++++++++++++++
 docs/functions/index.md                       |  1 +
 2 files changed, 36 insertions(+)
 create mode 100644 docs/functions/core/crypto/why2_seeded_random.md

diff --git a/docs/functions/core/crypto/why2_seeded_random.md b/docs/functions/core/crypto/why2_seeded_random.md
new file mode 100644
index 0000000..96b4434
--- /dev/null
+++ b/docs/functions/core/crypto/why2_seeded_random.md
@@ -0,0 +1,35 @@
+<!--
+This is part of WHY2
+Copyright (C) 2022 Václav Šmejkal
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+# why2_seeded_random
+
+## Parameters
+
+*This functions doesn't take any parameters.*
+
+## Attributes
+
+|                     |                                                                   |
+| ------------------  | ----------------------------------------------------------------- |
+| **Return type**     | `int`                                                             |
+| **Header comment**  | `GENERATE RANDOM NUMBER BASED ON SEED PASSED IN why2_seed_random` |
+| **Added in commit** | [`25113dc0b3c97178c85ac02c082164a6d36d3c1e`](https://github.com/ENGO150/WHY2/commit/25113dc0b3c97178c85ac02c082164a6d36d3c1e) |
+
+## Description
+
+Function generates pseudo random `int` with PRNG created in [`why2_seed_random`](../why2_seed_random). The function uses OpenSSL's [`HMAC`](https://docs.openssl.org/1.1.1/man3/HMAC).
\ No newline at end of file
diff --git a/docs/functions/index.md b/docs/functions/index.md
index cf01e64..cf22ad7 100644
--- a/docs/functions/index.md
+++ b/docs/functions/index.md
@@ -29,6 +29,7 @@ You can find documentation for every *public* function of WHY2 below.
 | [`why2_sum_segment`](./core/crypto/why2_sum_segment.md) | Calculate SUM++ for input; Used for padding seed |
 | [`why2_random`](./core/crypto/why2_random.md)           | Write crypto-secure random number into dest      |
 | [`why2_seed_random`](./core/crypto/why2_seed_random.md) | Seed why2_seeded_random output                   |
+| [`why2_seeded_random`](./core/crypto/why2_seeded_random.md) | GENERATE RANDOM NUMBER BASED ON SEED PASSED IN why2_seed_random |
 
 ## Logger