Skip to content

Commit a7c3e7e

Browse files
gmarullcarlescufi
authored andcommitted
doxygen: remove redundant usages of def
The def command Indicates that a comment block contains documentation for a #define macro. This is useful if the comment block documents a macro not adjacent to it, e.g. ```c /** * @def MAX(x,y) * @brief Computes the maximum of @A x and @A y. */ #ifdef XXX #define MAX(x,y) ... #endif ``` However, it is not necessary if the comment is adjacent to the definition, e.g. ```c /** * @brief Computes the maximum of @A x and @A y. */ #define MAX(x,y) ... ``` This patch removes all unnecessary def entries in-tree. Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent b896826 commit a7c3e7e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+779
-955
lines changed

drivers/sensor/vl53l0x/vl53l0x_platform.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ typedef struct {
4141
typedef VL53L0X_Dev_t *VL53L0X_DEV;
4242

4343
/**
44-
* @def PALDevDataGet
4544
* @brief Get ST private structure @a VL53L0X_DevData_t data access
4645
*
4746
* @param Dev Device Handle
@@ -53,7 +52,6 @@ typedef VL53L0X_Dev_t *VL53L0X_DEV;
5352
#define PALDevDataGet(Dev, field) (Dev->Data.field)
5453

5554
/**
56-
* @def PALDevDataSet(Dev, field, data)
5755
* @brief Set ST private structure @a VL53L0X_DevData_t data field
5856
* @param Dev Device Handle
5957
* @param field ST structure field name

include/zephyr/bluetooth/addr.h

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,7 @@ static inline bool bt_addr_le_is_identity(const bt_addr_le_t *addr)
164164
return BT_ADDR_IS_STATIC(&addr->a);
165165
}
166166

167-
/** @def BT_ADDR_STR_LEN
168-
*
167+
/**
169168
* @brief Recommended length of user string buffer for Bluetooth address
170169
*
171170
* @details The recommended length guarantee the output of address
@@ -174,8 +173,7 @@ static inline bool bt_addr_le_is_identity(const bt_addr_le_t *addr)
174173
*/
175174
#define BT_ADDR_STR_LEN 18
176175

177-
/** @def BT_ADDR_LE_STR_LEN
178-
*
176+
/**
179177
* @brief Recommended length of user string buffer for Bluetooth LE address
180178
*
181179
* @details The recommended length guarantee the output of address

0 commit comments

Comments
 (0)