Skip to content

Commit 80b7745

Browse files
kartbendanieldegrasse
authored andcommitted
include: math: doc: add doxygen groups
add doxygen groups to include/zephyr/math header files and fold them under Utilities top-level group. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 3d111dd commit 80b7745

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

include/zephyr/math/ilog2.h

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@
1818
* @brief Provide ilog2() function
1919
*/
2020

21+
/**
22+
* @defgroup math_ilog2 Math Ilog2 Functions
23+
* @ingroup utilities
24+
* @brief Integer log2 utilities for mathematical operations
25+
* @{
26+
*/
27+
2128
/**
2229
*
2330
* @brief Calculate the floor of log2 for compile time constant
@@ -97,4 +104,8 @@
97104
find_msb_set(n) - 1 \
98105
)
99106

107+
/**
108+
* @}
109+
*/
110+
100111
#endif /* ZEPHYR_INCLUDE_MATH_ILOG2_H_ */

include/zephyr/math/interpolation.h

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ extern "C" {
1919
* @brief Provide linear interpolation functions
2020
*/
2121

22+
/**
23+
* @defgroup math_interpolation Math Interpolation Functions
24+
* @ingroup utilities
25+
* @brief Linear interpolation utilities for mathematical operations
26+
* @{
27+
*/
28+
2229
/**
2330
* @brief Perform a linear interpolation across an arbitrary curve
2431
*
@@ -68,6 +75,10 @@ static inline int32_t linear_interpolate(const int32_t *x_axis, const int32_t *y
6875
return roundf(y_axis[idx_low] + (slope * x_shifted));
6976
}
7077

78+
/**
79+
* @}
80+
*/
81+
7182
#ifdef __cplusplus
7283
}
7384
#endif

0 commit comments

Comments
 (0)