1 %module doxygen_basic_translate_style3
2
3 %include "doxygen_basic_translate.h"
4
5 %inline %{
6
7 /// \brief
8 /// Brief description.
9 ///
10 /// The comment text.
11 ///
12 /// \author Some author
13 ///
14 /// \return Some number
15 ///
16 /// \sa function2
function()17 int function()
18 {
19 return 0;
20 }
21
22 /// A test of a very very very very very very very very very very very very very very very very
23 /// very very very very very long comment string.
function2()24 void function2()
25 {
26 }
27
28 /// A test for overloaded functions
29 /// This is function \b one
function3(int a)30 void function3(int a)
31 {
32 }
33
34 /// A test for overloaded functions
35 /// This is function \b two
function3(int a,int b)36 void function3(int a, int b)
37 {
38 }
39
40 /// A test of some mixed tag usage
41 /// \if CONDITION
42 /// This \a code fragment shows us something \.
43 /// \par Minuses:
44 /// \arg it's senseless
45 /// \arg it's stupid
46 /// \arg it's null
47 ///
48 /// \warning This may not work as expected
49 /// \code
50 /// int main() { while(true); }
51 ///
52 /// int testBlankLine() {}
53 /// \endcode
54 /// \endif
function4()55 void function4()
56 {
57 // Note: a comment in the above code block will not get processed
58 // correctly with this doxygen comment style, because
59 // DoxygenParser::tokenizeDoxygenComment strips out the leading
60 // comment characters. Whereas it works in the other doxygen
61 // comment styles (as shown in the other variations of
62 // doxygen_basic_translate), this test is modified to remove the
63 // comment within the code block.
64 }
65
66
function5(int a)67 void function5(int a)
68 {
69 }
70 ///< This is a post comment.
71
72 /// Test for default args
73 /// @param a Some parameter, default is 42
74 void function6(int a=42)
75 {
76 }
77
78 class Shape
79 {
80 public:
81 typedef Shape* superType;
82 };
83
84 /// Test for a parameter with difficult type
85 /// (mostly for python)
86 /// @param a Very strange param
function7(Shape::superType * a[10])87 void function7(Shape::superType *a[10])
88 {
89 }
90
91 /// Multiple parameters test.
92 ///
93 /// @param y Vertical coordinate.
94 /// @param x Horizontal coordinate.
95 /// @return Arc tangent of @c y/x.
Atan2(double y,double x)96 double Atan2(double y, double x)
97 {
98 return 0;
99 }
100
101 /// Comment at the end of file should be ignored.
102 %}
103