1 #ifndef _DOXYGEN_EXAMPLE_UNION_H_
2 #define _DOXYGEN_EXAMPLE_UNION_H_
3 
4 /**
5  * @page page_howto_union How to write doxygen documentation for union.
6  *
7  * A comment block before the union definition is recommended to
8  * describe the general information of the union 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 union, 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/union.h">documentation/0.doxygen/example/include/union.h</a>
17  * for code example.
18  *
19  * See @ref group_doxygen_example_union for html output.
20  */
21 
22 /**
23  * @defgroup group_doxygen_example_union Doxygen Example of Union
24  *
25  * @ingroup group_doxygen_example
26  *
27  * @brief Doxygen Example of Union.
28  *
29  * @{
30  */
31 
32 /**
33  * @brief Brief description of this union
34  */
35 union doxygen_example_union
36 {
37     int    v1; /**< description for v1 */
38     double v2; /**< description for v2 */
39 };
40 
41 /** @} */
42 
43 #endif /* _DOXYGEN_EXAMPLE_UNION_H_ */
44