mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-10-18 09:47:27 +08:00
3c8b23576f
Doxygen examples are grouped on different pages so that you can easily link to pages of related types in the documentation. For example, macro examples have their own page, and function examples have their own page, which correspond to their own code examples, such as "macro.h" or "function.h". Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
53 lines
1.7 KiB
C
53 lines
1.7 KiB
C
#ifndef _DOXYGEN_EXAMPLE_MACRO_H_
|
|
#define _DOXYGEN_EXAMPLE_MACRO_H_
|
|
|
|
/**
|
|
* @page page_howto_macro How to write doxygen documentation for macro.
|
|
*
|
|
* There are two typical types of macro definitions.
|
|
*
|
|
* - One is to define constant macros. For this type of macro, we
|
|
* recommend putting documentation after members. See `DOXYGEN_EXAMPLE_CONST_A`
|
|
* and `DOXYGEN_EXAMPLE_CONST_B` in
|
|
* <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/include/macro.h">documentation/0.doxygen/example/include/macro.h</a>
|
|
* for code exmaple.
|
|
*
|
|
* - The other is to define macros with parameters. For this type of
|
|
* macro, we recommend using a method similar to documenting for
|
|
* functions, that is, writing comment block before the macro definition.
|
|
* More details please see @ref page_howto_function
|
|
* See `DOXYGEN_EXAMPLE_ABS` in
|
|
* <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/include/macro.h">documentation/0.doxygen/example/include/macro.h</a>
|
|
* for code example.
|
|
*
|
|
* See
|
|
* <a href="./group__group__doxygen__example__macro.html">Doxygen Example of Macro</a>
|
|
* for html output.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup group_doxygen_example_macro Doxygen Example of Macro
|
|
*
|
|
* @ingroup group_doxygen_example
|
|
*
|
|
* @brief Doxygen Example of Macro.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#define DOXYGEN_EXAMPLE_CONST_A 100 /**< Description of macro const A */
|
|
#define DOXYGEN_EXAMPLE_CONST_B 200 /**< Description of macro const B */
|
|
|
|
/**
|
|
* @brief Computes the absolute value of its argument @a x.
|
|
*
|
|
* @param[in] x input value.
|
|
*
|
|
* @return absolute value of @a x.
|
|
*/
|
|
#define DOXYGEN_EXAMPLE_ABS(x) (((x)>0)?(x):-(x))
|
|
|
|
/** @} */
|
|
|
|
#endif
|