Skip to content

Commit d1d0dd4

Browse files
dbkindernashif
authored andcommitted
doc: fix missing NVS API documentation
Sphinx only displays API documentation for items within the specified doxygen defgroup, and importantly, not the subgroups of this defgroup. If you define a defgroup with defgroup children, you need to tell Sphinx to display API information about the child defgroups too. (If the parent defgroup has no entities of it's own, you can leave that out.) This patch replaces the (empty) display of the parent defgroup with that of its two child defgroups. It also fixes an unnecessarily long text line while I was in there. Fixes: #7666 Signed-off-by: David B. Kinder <[email protected]>
1 parent 38e8f06 commit d1d0dd4

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/subsystems/nvs/nvs.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ already performing such a check you can disable the extra flash protection
3232
(``CONFIG_NVS_FLASH_PROTECTION=n``).
3333

3434
To protect the storage system against frequent sector erases the size of
35-
id-data pairs is limited to ``CONFIG_NVS_MAX_ELEM_SIZE``. This limit is by default set to 1/4 of the sector
36-
size.
35+
id-data pairs is limited to ``CONFIG_NVS_MAX_ELEM_SIZE``. This limit is
36+
by default set to 1/4 of the sector size.
3737

3838

3939
For NVS the file system is declared as:
@@ -107,5 +107,8 @@ API
107107

108108
The NVS subsystem APIs are provided by ``nvs.h``:
109109

110-
.. doxygengroup:: nvs
110+
.. doxygengroup:: nvs_data_structures
111+
:project: Zephyr
112+
113+
.. doxygengroup:: nvs_high_level_api
111114
:project: Zephyr

0 commit comments

Comments
 (0)