blob: 32e3cfcbe0a8a2a01f55522fefb48237b3500a7a (
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
|
%module doxygen_basic_translate_style2
%include "doxygen_basic_translate.h"
// This test demonstrates a doxygen comment style that starts on the
// first line and so uses extra spacing in subsequent lines.
%inline %{
/** \brief
* Brief description.
*
* The comment text.
*
* \author Some author
*
* \return Some number
*
* \sa function2
*/
int function()
{
return 0;
}
/** A test of a very very very very very very very very very very very very very very very very
* very very very very very long comment string.
*/
void function2()
{
}
/** A test for overloaded functions
* This is function \b one
*/
void function3(int a)
{
}
/** A test for overloaded functions
* This is function \b two
*/
void function3(int a, int b)
{
}
/** A test of some mixed tag usage
* \if CONDITION
* This \a code fragment shows us something \.
* \par Minuses:
* \arg it's senseless
* \arg it's stupid
* \arg it's null
*
* \warning This may not work as expected
* \code
* int main() { while(true); }
*
* // Test blank line in code block
* \endcode
* \endif
*/
void function4()
{
}
void function5(int a)
{
}
/**< This is a post comment. */
/** Test for default args
* @param a Some parameter, default is 42
*/
void function6(int a=42)
{
}
class Shape
{
public:
typedef Shape* superType;
};
/** Test for a parameter with difficult type
* (mostly for python)
* @param a Very strange param
*/
void function7(Shape::superType *a[10])
{
}
/** Multiple parameters test.
*
* @param y Vertical coordinate.
* @param x Horizontal coordinate.
* @return Arc tangent of @c y/x.
*/
double Atan2(double y, double x)
{
return 0;
}
/** Comment at the end of file should be ignored.
*/
%}
|
