ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #6280 from davidsaada/david_nvstore_doxygen_only 

NVStore: Enclose header file with DOXYGEN_ONLY option as well.
pull/6302/merge
Martin Kojtal 2018-03-08 17:40:12 +01:00 committed by GitHub
parent 87b37c0e2a 9e35f8283e
commit 0c0826179f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
features/nvstore/source/nvstore.h
View File

@ -23,7 +23,7 @@
#define NVSTORE_ENABLED 0 #define NVSTORE_ENABLED 0
#endif #endif
#if NVSTORE_ENABLED #if (NVSTORE_ENABLED) || defined(DOXYGEN_ONLY)
#include <stdint.h> #include <stdint.h>
#include <stdio.h> #include <stdio.h>
#include "platform/NonCopyable.h" #include "platform/NonCopyable.h"
@ -286,8 +286,6 @@ private:
/** /**
* @brief Calculate addresses and sizes of areas (in case no user configuration is given), * @brief Calculate addresses and sizes of areas (in case no user configuration is given),
* or validate user configuration (if given). * or validate user configuration (if given).
*
* @param[in] area Area.
*/ */
void calc_validate_area_params(); void calc_validate_area_params();
@ -310,7 +308,7 @@ private:
* @param[in] buf Output Buffer. * @param[in] buf Output Buffer.
* @param[out] actual_size Actual data size (bytes). * @param[out] actual_size Actual data size (bytes).
* @param[in] validate_only Just validate (without reading to buffer). * @param[in] validate_only Just validate (without reading to buffer).
* @param[out] validate Is the record valid. * @param[out] valid Is the record valid.
* @param[out] key Record key. * @param[out] key Record key.
* @param[out] flags Record flags. * @param[out] flags Record flags.
* @param[out] next_offset Offset of next record. * @param[out] next_offset Offset of next record.