Skip to content

Commit e46e165

Browse files
committed
Minor workaround in doxygen_basic_translate_style3 test
With the "///" doxygen comment style, comments within a code block do not get handled correctly. Modifying the test to remove this case and adding a note about it for future reference.
1 parent feea39f commit e46e165

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

Examples/test-suite/doxygen_basic_translate_style3.i

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,18 @@ void function3(int a, int b)
4949
/// \code
5050
/// int main() { while(true); }
5151
///
52-
/// // Test blank line in code block
52+
/// int testBlankLine() {}
5353
/// \endcode
5454
/// \endif
5555
void function4()
5656
{
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.
5764
}
5865

5966

Examples/test-suite/java/doxygen_basic_translate_style3_runme.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ and calls the start() method of that class with parsed information.
5555
" {@code \n" +
5656
"int main() { while(true); } \n" +
5757
"\n" +
58-
"// Test blank line in code block \n" +
58+
"int testBlankLine() {} \n" +
5959
" }\n" +
6060
" }\n" +
6161
" \n" +

Examples/test-suite/python/doxygen_basic_translate_style3_runme.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
5050
int main() { while(true); }
5151
52-
// Test blank line in code block
52+
int testBlankLine() {}
5353
}"""
5454
)
5555
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_style3.function5),

0 commit comments

Comments
 (0)