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/htbt.h | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'src/htbt.h') diff --git a/src/htbt.h b/src/htbt.h index 9dc20a8..80a0c0f 100644 --- a/src/htbt.h +++ b/src/htbt.h @@ -210,14 +210,12 @@ struct prne_htbt_param { prne_htbt_t *prne_alloc_htbt (prne_worker_t *w, const prne_htbt_param_t *param); /** - * \brief Initialise the heartbeat worker parameter object - * \note Initialises the members of \p p to initial values. Prepares \p p so - * that it can be freed using \c prne_htbt_free_param() + * \brief Initialisation function + * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation) */ void prne_htbt_init_param (prne_htbt_param_t *p); /** - * \brief Free the resources allocated for the heartbeat worker parameter object - * \param p The pointer to the object that has been initialised using - * \c prne_htbt_init_param() + * \brief Deinitialisation function + * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation) */ void prne_htbt_free_param (prne_htbt_param_t *p); -- cgit