diff options
| author | David Timber <dxdt@dev.snart.me> | 2022-06-02 12:19:11 +0800 |
|---|---|---|
| committer | David Timber <dxdt@dev.snart.me> | 2022-06-02 12:19:11 +0800 |
| commit | 31e7acb5c965067463f33fa59fc463086a298350 (patch) | |
| tree | 921df7d673b812255da0bca13b967930a498a7ff /src/dvault.h | |
| parent | 80a062ef30a2f945f6634ca9a0bf2b886a54e3ae (diff) | |
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()
Diffstat (limited to 'src/dvault.h')
| -rw-r--r-- | src/dvault.h | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/src/dvault.h b/src/dvault.h index 0f52518..ef0b907 100644 --- a/src/dvault.h +++ b/src/dvault.h @@ -101,16 +101,13 @@ void prne_dvault_invert_mem ( const uint8_t *mask); /** - * \brief Initialise the data vault masking operation result object - * \note Initialises the members of \p r to initial values. Prepares \p r so - * that it can be freed using \c prne_free_dvault_mask_result() + * \brief Initialisation function + * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation) */ void prne_init_dvault_mask_result (prne_dvault_mask_result_t *r); /** - * \brief Free the resources allocated for the the data vault masking operation - * result object - * \param p The pointer to the object that has been initialised using - * \c prne_init_dvault_mask_result() + * \brief Deinitialisation function + * \see [/doc/impl.md#Resource Allocation](/doc/impl.md#resource_allocation) */ void prne_free_dvault_mask_result (prne_dvault_mask_result_t *r); /** |