diff options
Diffstat (limited to 'src/bne.h')
-rw-r--r-- | src/bne.h | 10 |
1 files changed, 4 insertions, 6 deletions
@@ -319,15 +319,13 @@ struct prne_bne_result { }; /** - * \brief Initialise the BNE 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_free_bne_param() + * \brief Initialisation function + * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation) */ void prne_init_bne_param (prne_bne_param_t *p); /** - * \brief Free the resources allocated for the BNE worker parameter object - * \param p The pointer to the object that has been initialised using - * \c prne_init_bne_param() + * \brief Deinitialisation function + * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation) */ void prne_free_bne_param (prne_bne_param_t *p); |