From 31e7acb5c965067463f33fa59fc463086a298350 Mon Sep 17 00:00:00 2001 From: David Timber Date: Thu, 2 Jun 2022 12:19:11 +0800 Subject: 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() --- src/rnd.h | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'src/rnd.h') 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); /** -- cgit