mirror of https://github.com/swig/swig
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.
This commit is contained in:
parent
feea39f352
commit
e46e1655cd
|
@ -49,11 +49,18 @@ void function3(int a, int b)
|
|||
/// \code
|
||||
/// int main() { while(true); }
|
||||
///
|
||||
/// // Test blank line in code block
|
||||
/// int testBlankLine() {}
|
||||
/// \endcode
|
||||
/// \endif
|
||||
void function4()
|
||||
{
|
||||
// Note: a comment in the above code block will not get processed
|
||||
// correctly with this doxygen comment style, because
|
||||
// DoxygenParser::tokenizeDoxygenComment strips out the leading
|
||||
// comment characters. Whereas it works in the other doxygen
|
||||
// comment styles (as shown in the other variations of
|
||||
// doxygen_basic_translate), this test is modified to remove the
|
||||
// comment within the code block.
|
||||
}
|
||||
|
||||
|
||||
|
|
|
@ -55,7 +55,7 @@ public class doxygen_basic_translate_style3_runme {
|
|||
" {@code \n" +
|
||||
"int main() { while(true); } \n" +
|
||||
"\n" +
|
||||
"// Test blank line in code block \n" +
|
||||
"int testBlankLine() {} \n" +
|
||||
" }\n" +
|
||||
" }\n" +
|
||||
" \n" +
|
||||
|
|
|
@ -49,7 +49,7 @@ Warning: This may not work as expected
|
|||
|
||||
int main() { while(true); }
|
||||
|
||||
// Test blank line in code block
|
||||
int testBlankLine() {}
|
||||
}"""
|
||||
)
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_style3.function5),
|
||||
|
|
Loading…
Reference in New Issue