1 #ifndef _DOXYGEN_EXAMPLE_ENUM_H_
2 #define _DOXYGEN_EXAMPLE_ENUM_H_
3 
4 /**
5  * @page page_howto_enum How to write doxygen documentation for enumeration.
6  *
7  * A comment block before the enumeration definition is recommended to
8  * describe the general information of the enumeration type. In the
9  * comment block, a `@brief` is required, other commands (such as `@note`)
10  * are optional.
11  *
12  * To describe the values of the enumeration, document is recommended
13  * to be put after each value.
14  *
15  * See
16  * <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/include/enum.h">documentation/0.doxygen/example/include/enum.h</a>
17  * for code example.
18  *
19  * See @ref group_doxygen_example_enum for html output.
20  */
21 
22 /**
23  * @defgroup group_doxygen_example_enum Doxygen Example of Enumeration
24  *
25  * @ingroup group_doxygen_example
26  *
27  * @brief Doxygen Example of Enumeration.
28  *
29  * @{
30  */
31 
32 /**
33  * @brief Brief description of this enumeration
34  */
35 enum doxygen_example_enum
36 {
37     V1, /**< description for value 1 */
38     V2, /**< description for value 2 */
39 };
40 
41 /** @} */
42 
43 #endif /* _DOXYGEN_EXAMPLE_ENUM_H_ */
44