aboutsummaryrefslogtreecommitdiff
path: root/src/rnd.h
diff options
context:
space:
mode:
authorDavid Timber <dxdt@dev.snart.me>2022-06-02 12:19:11 +0800
committerDavid Timber <dxdt@dev.snart.me>2022-06-02 12:19:11 +0800
commit31e7acb5c965067463f33fa59fc463086a298350 (patch)
tree921df7d673b812255da0bca13b967930a498a7ff /src/rnd.h
parent80a062ef30a2f945f6634ca9a0bf2b886a54e3ae (diff)
Doc and final touches ...
- Add .settings.json for doxygen settings - Add /doc/impl.md - Doc and change usage of /bootstrap.sh - Add notes to docs - Add 7-bit char machine check - Normailise description for init and free functions - Doc rest of source code - Remove unused function: prne_str_shift_spaces()
Diffstat (limited to 'src/rnd.h')
-rw-r--r--src/rnd.h10
1 files changed, 4 insertions, 6 deletions
diff --git a/src/rnd.h b/src/rnd.h
index b414081..5287f1c 100644
--- a/src/rnd.h
+++ b/src/rnd.h
@@ -47,15 +47,13 @@ typedef struct prne_rnd prne_rnd_t;
/**
- * \brief Initialise the PRNG engine object
- * \note Initialises the members of \p p to initial values. Prepares \p p so
- * that it can be freed using \c prne_free_rnd()
+ * \brief Initialisation function
+ * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation)
*/
void prne_init_rnd (prne_rnd_t *p);
/**
- * \brief Free the resources allocated for the PRNG engine object
- * \param p The pointer to the object that has been initialised using
- * \c prne_init_rnd()
+ * \brief Deinitialisation function
+ * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation)
*/
void prne_free_rnd (prne_rnd_t *p);
/**