jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Preserve relative indentation when parsing Doxygen comments.

Browse source 
This is important to preserve the structure of the lists which appear
correctly in Python output without any additional effort if the indentation is
lost.

It is also makes the behaviour consistent for

	/**
	 *
	 *
	 */

comments and those without the asterisks in the middle lines, as now the
indentation is preserved in both cases while it was only preserved when the
asterisks were present previously.
This commit is contained in:
Vadim Zeitlin 2014-07-14 02:29:49 +02:00
commit 14ba3b8dd4
4 changed files with 56 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Examples/test-suite/java/doxygen_misc_constructs_runme.java
View file

@ -117,6 +117,18 @@ public class doxygen_misc_constructs_runme {
wantedComments.put("doxygen_misc_constructs.ClassWithNestedEnum.ENested.THREE",
" desc of three\n");
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.showList()",
" An example of a list in a documentation comment.<br>\n" +
" <br>\n" +
" - The first item of the list.<br>\n" +
" - The second list item, on<br>\n" +
" several indented lines,<br>\n" +
" showing that the indentation<br>\n" +
" is preserved.<br>\n" +
" - And the final list item after it.<br>\n" +
" <br>\n" +
" And this is not a list item any more.\n" +
"");
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.isNoSpaceValidA()",
" This comment without space after '*' is valid in Doxygen.\n" +
"\n" +
@ -182,4 +194,4 @@ public class doxygen_misc_constructs_runme {
// and ask the parser to check comments for us
System.exit(parser.check(wantedComments));
}
}
}