diff options
Diffstat (limited to 'templates/doxygen')
| -rw-r--r-- | templates/doxygen | 12 |
1 files changed, 6 insertions, 6 deletions
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) */ /** |