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

Add doxygen testing of Java constructor wrappers

Browse source
This commit is contained in:
William S Fulton 2018-06-18 18:56:21 +01:00
commit 602b0d5a2c
6 changed files with 20 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

1
Examples/test-suite/doxygen_nested_class.i
View file

@ -7,6 +7,7 @@
struct DoxOuter { struct DoxOuter {
/** DoxOuter constructor */ /** DoxOuter constructor */
DoxOuter() {} DoxOuter() {}
/** DoxInner class description */
struct DoxInner { struct DoxInner {
/** DoxInner constructor */ /** DoxInner constructor */
DoxInner() {} DoxInner() {}

1
Examples/test-suite/doxygen_parsing.i
View file

@ -41,6 +41,7 @@ int someVar=42;
*/ */
#define CONSTANT_VALUE 4242 #define CONSTANT_VALUE 4242
/// SomeAnotherClass description
class SomeAnotherClass class SomeAnotherClass
{ {
public: public:

4
Examples/test-suite/java/CommentParser.java
View file

@ -34,6 +34,10 @@ public class CommentParser {
if (f.getRawCommentText().length() > 0) if (f.getRawCommentText().length() > 0)
m_parsedComments.put(f.qualifiedName(), f.getRawCommentText()); m_parsedComments.put(f.qualifiedName(), f.getRawCommentText());
} }
for (ConstructorDoc c : classDoc.constructors()) {
if (c.getRawCommentText().length() > 0)
m_parsedComments.put(c.toString(), c.getRawCommentText());
}
for (MethodDoc m : classDoc.methods()) { for (MethodDoc m : classDoc.methods()) {
if (m.getRawCommentText().length() > 0) if (m.getRawCommentText().length() > 0)
m_parsedComments.put(m.toString(), m.getRawCommentText()); m_parsedComments.put(m.toString(), m.getRawCommentText());

10
Examples/test-suite/java/doxygen_nested_class_runme.java
View file

@ -25,10 +25,12 @@ public class doxygen_nested_class_runme {
HashMap<String, String> wantedComments = new HashMap<String, String>(); HashMap<String, String> wantedComments = new HashMap<String, String>();
// wantedComments.put("doxygen_nested_class.DoxOuter.DoxOuter()", wantedComments.put("doxygen_nested_class.DoxOuter()",
// " DoxOuter constructor "); " DoxOuter constructor ");
// wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner.DoxInner()", wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner",
// " DoxInner constructor "); " DoxInner class description ");
wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner()",
" DoxInner constructor ");
wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner.setDoxInt(int)", wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner.setDoxInt(int)",
" doxInt variable "); " doxInt variable ");
wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner.getDoxInt()", wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner.getDoxInt()",

6
Examples/test-suite/java/doxygen_parsing_runme.java
View file

@ -26,6 +26,12 @@ public class doxygen_parsing_runme {
HashMap<String, String> wantedComments = new HashMap<String, String>(); HashMap<String, String> wantedComments = new HashMap<String, String>();
wantedComments.put("doxygen_parsing.SomeAnotherClass",
" SomeAnotherClass description");
wantedComments.put("doxygen_parsing.SomeAnotherClass(int)",
" First overloaded constructor.");
wantedComments.put("doxygen_parsing.SomeAnotherClass(java.lang.String)",
" Second overloaded constructor.");
wantedComments.put("doxygen_parsing.SomeAnotherClass.getClassAttr()", wantedComments.put("doxygen_parsing.SomeAnotherClass.getClassAttr()",
" The class attribute comment \n" + " The class attribute comment \n" +
" \n" + " \n" +

2
Examples/test-suite/python/doxygen_parsing_runme.py
View file

@ -11,6 +11,8 @@ comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeClass),
"The class comment") "The class comment")
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeStruct), comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeStruct),
"The struct comment") "The struct comment")
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass),
"SomeAnotherClass description")
# There doesn't seem to be any way to specify the doc string for __init__ when # There doesn't seem to be any way to specify the doc string for __init__ when
# using "-builtin" (see http://stackoverflow.com/q/11913492/15275), so skip # using "-builtin" (see http://stackoverflow.com/q/11913492/15275), so skip