From 3ebb5a08ecf982c10a18c0596be4bb2549a815c9 Mon Sep 17 00:00:00 2001 From: ENGO150 Date: Sat, 25 Jan 2025 15:31:36 +0100 Subject: [PATCH] removed markdown extension from URLs --- docs/functions/core/crypto/why2_random.md | 2 +- docs/functions/core/crypto/why2_sum_segment.md | 2 +- docs/functions/index.md | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/functions/core/crypto/why2_random.md b/docs/functions/core/crypto/why2_random.md index 04bdc9f..314459e 100644 --- a/docs/functions/core/crypto/why2_random.md +++ b/docs/functions/core/crypto/why2_random.md @@ -29,7 +29,7 @@ along with this program. If not, see . | | | | ------------------ | -------------------------------------------------------- | -| **Return type** | [`why2_bool`](../../../../types/core/flags/why2_bool.md) | +| **Return type** | [`why2_bool`](../../../../types/core/flags/why2_bool) | | **Header comment** | `WRITE CRYPTO-SECURE RANDOM NUMBER INTO dest` | | **Added in commit** | [`f95608f52a0a82b3a8c005c7f8dad0b9cf93202a`](https://github.com/ENGO150/WHY2/commit/f95608f52a0a82b3a8c005c7f8dad0b9cf93202a) | diff --git a/docs/functions/core/crypto/why2_sum_segment.md b/docs/functions/core/crypto/why2_sum_segment.md index d8f60bc..6fd72ac 100644 --- a/docs/functions/core/crypto/why2_sum_segment.md +++ b/docs/functions/core/crypto/why2_sum_segment.md @@ -34,7 +34,7 @@ along with this program. If not, see . ## Description -Function takes `input` parameter and divides it into segments of [`WHY2_SUM_SEGMENT_SIZE`](../../../../macros/core/crypto/why2_sum_segment_size.md). Each segment does some xoring, math using [`WHY2_SUM_BASE_PRIME`](../../../../macros/core/crypto/why2_sum_base_prime.md) and modulates each segment with [`WHY2_SUM_MOD_PRIME`](../../../../macros/core/crypto/why2_sum_mod_prime.md). The result is then added together and returned. +Function takes `input` parameter and divides it into segments of [`WHY2_SUM_SEGMENT_SIZE`](../../../../macros/core/crypto/why2_sum_segment_size). Each segment does some xoring, math using [`WHY2_SUM_BASE_PRIME`](../../../../macros/core/crypto/why2_sum_base_prime) and modulates each segment with [`WHY2_SUM_MOD_PRIME`](../../../../macros/core/crypto/why2_sum_mod_prime). The result is then added together and returned. Output value grows rapidly with increasing `input` length, but unless you are using enormously large keys, nothing should overflow. Function was tested with lengths up to 4096 chars and output was only about 0,0000014 % of the `ULL` range. diff --git a/docs/functions/index.md b/docs/functions/index.md index cf22ad7..26afce6 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -26,10 +26,10 @@ You can find documentation for every *public* function of WHY2 below. | Function | Description | | ------------------------------------------------------- | ------------------------------------------------ | -| [`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 | +| [`why2_sum_segment`](./core/crypto/why2_sum_segment) | Calculate SUM++ for input; Used for padding seed | +| [`why2_random`](./core/crypto/why2_random) | Write crypto-secure random number into dest | +| [`why2_seed_random`](./core/crypto/why2_seed_random) | Seed why2_seeded_random output | +| [`why2_seeded_random`](./core/crypto/why2_seeded_random) | GENERATE RANDOM NUMBER BASED ON SEED PASSED IN why2_seed_random | ## Logger