Skip to content

Commit c416937

Browse files
committed
include: drivers: flash: clean up doxygen
Rework doxygen group naming and fold "internal" Flash API into the main Flash API group. Also a minor fix of a missing javadoc-style comment. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 6a98a11 commit c416937

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

include/zephyr/drivers/flash.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
#define ZEPHYR_INCLUDE_DRIVERS_FLASH_H_
1515

1616
/**
17-
* @brief FLASH internal Interface
18-
* @defgroup flash_internal_interface FLASH internal Interface
19-
* @ingroup io_interfaces
17+
* @brief Internal interfaces for flash memory controllers.
18+
* @defgroup flash_internal_interface Flash Internal
19+
* @ingroup flash_interface
2020
* @{
2121
*/
2222

@@ -43,8 +43,8 @@ struct flash_pages_layout {
4343
*/
4444

4545
/**
46-
* @brief FLASH Interface
47-
* @defgroup flash_interface FLASH Interface
46+
* @brief Interfaces for flash memory controllers.
47+
* @defgroup flash_interface Flash
4848
* @since 1.2
4949
* @version 1.0.0
5050
* @ingroup io_interfaces
@@ -94,8 +94,8 @@ struct flash_parameters {
9494
#define FLASH_ERASE_C_VAL_BIT 0x04
9595
#define FLASH_ERASE_UNIFORM_PAGE 0x08
9696

97-
98-
/* @brief Parser for flash_parameters for retrieving erase capabilities
97+
/**
98+
* @brief Parser for flash_parameters for retrieving erase capabilities
9999
*
100100
* The functions parses flash_parameters type object and returns combination
101101
* of erase capabilities of 0 if device does not have any.

0 commit comments

Comments
 (0)