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() --- templates/doxygen | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'templates') diff --git a/templates/doxygen b/templates/doxygen index 7129842..0e5293b 100644 --- a/templates/doxygen +++ b/templates/doxygen @@ -11,16 +11,15 @@ */ /** - * \brief Initialise the - * \note Initialises the members of \p x to initial values. Prepares \p x so - * that it can be freed using \c ff() + * \brief Initialisation function + * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation) */ /** - * \brief Free the resources allocated for the - * \param x The pointer to the object that has been initialised using - * \c if() + * \brief Deinitialisation function + * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation) */ + /** * \brief The equality operator of the * \retval true if the contents of both \p a and \p b are identical @@ -38,6 +37,7 @@ * \param x The byte length required for the * \return true if allocation was successful * \return false on failure and \c errno set to \c ENOMEM + * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation) */ /** -- cgit