Skip to content

NVStore: Enclose header file with DOXYGEN_ONLY option as well. #6280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 8, 2018
Merged

NVStore: Enclose header file with DOXYGEN_ONLY option as well. #6280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions features/nvstore/source/nvstore.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#define NVSTORE_ENABLED 0
#endif

#if NVSTORE_ENABLED
#if (NVSTORE_ENABLED) || defined(DOXYGEN_ONLY)
#include <stdint.h>
#include <stdio.h>
#include "platform/NonCopyable.h"
Expand Down Expand Up @@ -286,8 +286,6 @@ class NVStore : private mbed::NonCopyable<NVStore> {
/**
* @brief Calculate addresses and sizes of areas (in case no user configuration is given),
* or validate user configuration (if given).
*
* @param[in] area Area.
*/
void calc_validate_area_params();

Expand All @@ -310,7 +308,7 @@ class NVStore : private mbed::NonCopyable<NVStore> {
* @param[in] buf Output Buffer.
* @param[out] actual_size Actual data size (bytes).
* @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] flags Record flags.
* @param[out] next_offset Offset of next record.
Expand Down