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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
%module doxygen_parsing
%inline %{
/**
* The class comment
*/
class SomeClass
{
};
/**
* The function comment
*/
void someFunction()
{
}
/**
* The enum comment
*/
enum SomeEnum
{
SOME_ENUM_ITEM
};
/**
* The struct comment
*/
struct SomeStruct
{
int width; ///< \**immutable** image width in pixels
};
/**
* The var comment
*/
int someVar=42;
/**
* The constant comment
*/
#define CONSTANT_VALUE 4242
/**
* A two line
* constant comment
*/
#define CONSTANT_VALUE_TWO_LINE 5353
/// SomeAnotherClass description
class SomeAnotherClass
{
public:
/// First overloaded constructor.
SomeAnotherClass(int) { }
/// Second overloaded constructor.
SomeAnotherClass(const char*) { }
/**
* The class attribute comment
*/
int classAttr;
int classAttr2; ///< The class attribute post-comment
int classAttr3; ///< The class attribute post-comment
//!< with details
/**
* The class attribute comment with
* two lines of comments
*/
int classAttr4;
/**
* The class method comment.
*
* \link SomeAnotherClass#classMethodExtended(int, int) a link text \endlink
*/
void classMethod()
{
}
/**
* The class method with parameter
*/
void classMethodExtended(
int a, ///< Parameter a
int b ///< Parameter b
)
{
}
/**
* The class method with parameter
*
* @param a Parameter a
* @param b Parameter b
*/
void classMethodExtended2(int a, int b)
{
}
};
struct SomeAnotherStruct
{
/**
* The struct attribute comment
*/
int structAttr;
int structAttr2; ///< The struct attribute post-comment
int structAttr3; ///< The struct attribute post-comment
//!< with details
/**
* The struct attribute comment with
* two lines of comments
*/
int structAttr4;
/**
* The struct method comment
*/
void structMethod()
{
}
/**
* The struct method with parameter
*/
void structMethodExtended(
int a, ///< Parameter a
int b ///< Parameter b
)
{
}
/**
* The struct method with parameter
*
* @param a Parameter a
* @param b Parameter b
*/
void structMethodExtended2(int a, int b)
{
}
/**
* The struct static method one line comment
*/
static void structStaticMethod(int xxx, int yyy)
{
}
/**
* The struct static method with parameters
* Two lines of comments
*
* @param aaa Parameter aaa
* @param bbb Parameter bbb
*/
static void structStaticMethod2(int aaa, int bbb)
{
}
};
struct Foo1636
{
///@{
/// groupmember1 description
int groupmember1;
/// groupmember2 description
int groupmember2;
///@}
};
struct Foo1750
{
/// @name Group name
/// @{
int a;
/// @}
int b;
};
#ifdef SWIGPYTHON_BUILTIN
bool is_python_builtin() { return true; }
#else
bool is_python_builtin() { return false; }
#endif
%}
|
