Add a possibility to flexibly ignore custom Doxygen tags.
Add %feature("doxygen:ignore:<command>") implementation, documentation and
test case.
This feature allows to use custom tags in C++ Doxygen comments for
C++-specific things that don't make sense in the context of the target
language and also allows to insert contents specific to the target language in
the C++ comments using (different) custom commands, which is very useful in
practice to explain the particularities of the API wrappers.
This commit is contained in:
parent
cd1f4619d2
commit
05b5ed11bc
7 changed files with 360 additions and 0 deletions
44
Examples/test-suite/java/doxygen_ignore_runme.java
Normal file
44
Examples/test-suite/java/doxygen_ignore_runme.java
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
|
||||
import doxygen_ignore.*;
|
||||
import com.sun.javadoc.*;
|
||||
import java.util.HashMap;
|
||||
|
||||
public class doxygen_ignore_runme {
|
||||
static {
|
||||
try {
|
||||
System.loadLibrary("doxygen_ignore");
|
||||
} catch (UnsatisfiedLinkError e) {
|
||||
System.err.println("Native code library failed to load. See the chapter on Dynamic Linking Problems in the SWIG Java documentation for help.\n" + e);
|
||||
System.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
public static void main(String argv[])
|
||||
{
|
||||
CommentParser parser = new CommentParser();
|
||||
com.sun.tools.javadoc.Main.execute("doxygen_ignore runtime test",
|
||||
"CommentParser",
|
||||
new String[]{"-quiet", "doxygen_ignore"});
|
||||
|
||||
HashMap<String, String> wantedComments = new HashMap<String, String>();
|
||||
wantedComments.put("doxygen_ignore.doxygen_ignore.func()",
|
||||
" A contrived example of ignoring too many commands in one comment.<br>\n" +
|
||||
" <br>\n" +
|
||||
" <br>\n" +
|
||||
" <br>\n" +
|
||||
" <br>\n" +
|
||||
" This is specific to <i>Java</i>.<br>\n" +
|
||||
" <br>\n" +
|
||||
" <br>\n" +
|
||||
" <br>\n" +
|
||||
" <br>\n" +
|
||||
" Command ignored, but anything here is still included.<br>\n" +
|
||||
" <br>\n" +
|
||||
"\n" +
|
||||
"\n" +
|
||||
"\n" +
|
||||
"");
|
||||
|
||||
System.exit(parser.check(wantedComments));
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue