Skip to content

Commit 0c08261

Browse files
authored
Merge pull request #6280 from davidsaada/david_nvstore_doxygen_only
NVStore: Enclose header file with DOXYGEN_ONLY option as well.
2 parents 87b37c0 + 9e35f82 commit 0c08261

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

features/nvstore/source/nvstore.h

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
#define NVSTORE_ENABLED 0
2424
#endif
2525

26-
#if NVSTORE_ENABLED
26+
#if (NVSTORE_ENABLED) || defined(DOXYGEN_ONLY)
2727
#include <stdint.h>
2828
#include <stdio.h>
2929
#include "platform/NonCopyable.h"
@@ -286,8 +286,6 @@ class NVStore : private mbed::NonCopyable<NVStore> {
286286
/**
287287
* @brief Calculate addresses and sizes of areas (in case no user configuration is given),
288288
* or validate user configuration (if given).
289-
*
290-
* @param[in] area Area.
291289
*/
292290
void calc_validate_area_params();
293291

@@ -310,7 +308,7 @@ class NVStore : private mbed::NonCopyable<NVStore> {
310308
* @param[in] buf Output Buffer.
311309
* @param[out] actual_size Actual data size (bytes).
312310
* @param[in] validate_only Just validate (without reading to buffer).
313-
* @param[out] validate Is the record valid.
311+
* @param[out] valid Is the record valid.
314312
* @param[out] key Record key.
315313
* @param[out] flags Record flags.
316314
* @param[out] next_offset Offset of next record.

0 commit comments

Comments
 (0)