blob: eeddd9faae95011381ae0fb90a7eba596a398f45 (
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
#ifndef _EOLIAN_OUTPUT_H_
#define _EOLIAN_OUTPUT_H_
#ifndef _DOCS_EO_CLASS_TYPE
#define _DOCS_EO_CLASS_TYPE
typedef Eo Docs;
#endif
#ifndef _DOCS_EO_TYPES
#define _DOCS_EO_TYPES
/**
* @brief This is struct Foo. It does stuff.
*
* This is a longer description for struct Foo.
*
* This is another paragraph.
*
* @since 1.66
*
* @ingroup Foo
*/
typedef struct _Foo
{
int field1; /** Field documentation. */
float field2;
short field3; /** Another field documentation. */
} Foo;
/** Docs for enum Bar.
*
* @ingroup Bar
*/
typedef enum
{
BAR_BLAH = 0,
BAR_FOO = 1, /** Docs for foo. */
BAR_BAR = 2 /** Docs for bar. */
} Bar;
/**
* @brief Docs for typedef.
*
* More docs for typedef. See @ref Bar.
*
* @since 2.0
*
* @ingroup Alias
*/
typedef Bar Alias;
/** Opaque struct docs. See @ref Foo for another struct.
*
* @ingroup Opaque
*/
typedef struct _Opaque Opaque;
#endif
/**
* @brief Docs for class.
*
* More docs for class. Testing references now. @ref Foo @ref Bar @ref Alias
* @ref pants @ref docs_meth @ref docs_prop_get @ref docs_prop_get
* @ref docs_prop_set @ref Foo.field1 @ref Bar.BAR_FOO @ref Docs
*
* @ingroup Docs
*/
/**
* @brief Property common documentation.
*
* Set documentation.
*
* @param[in] val Value documentation.
*
* @since 1.18
*
* @ingroup Docs
*/
EAPI void docs_prop_set(Docs *obj, int val);
/**
* @brief Property common documentation.
*
* Get documentation.
*
* @return Value documentation.
*
* @since 1.18
*
* @ingroup Docs
*/
EAPI int docs_prop_get(const Docs *obj);
/**
* @brief Method documentation.
*
* @param[out] b
* @param[out] c Another param documentation.
*
* @return Return documentation.
*
* @ingroup Docs
*/
EAPI int docs_meth(Docs *obj, int a, float *b, long *c);
#endif
|
