blob: 7062fc6c935f8487b99836bf50833bd921ead25b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
#ifndef _DOXYGEN_EXAMPLE_UNION_H_
#define _DOXYGEN_EXAMPLE_UNION_H_
/**
* @page page_howto_union How to write doxygen documentation for union.
*
* A comment block before the union definition is recommended to
* describe the general information of the union type. In the
* comment block, a `@brief` is required, other commands (such as `@note`)
* are optional.
*
* To describe the values of the union, document is recommended
* to be put after each value.
*
* See
* <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>
* for code example.
*
* See @ref group_doxygen_example_union for html output.
*/
/**
* @defgroup group_doxygen_example_union Doxygen Example of Union
*
* @ingroup group_doxygen_example
*
* @brief Doxygen Example of Union.
*
* @{
*/
/**
* @brief Brief description of this union
*/
union doxygen_example_union
{
int v1; /**< description for v1 */
double v2; /**< description for v2 */
};
/** @} */
#endif /* _DOXYGEN_EXAMPLE_UNION_H_ */
|
