From 602b0d5a2c3d4fa0e0af0d9c6c64a62663f6092a Mon Sep 17 00:00:00 2001 From: William S Fulton Date: Mon, 18 Jun 2018 18:56:21 +0100 Subject: [PATCH] Add doxygen testing of Java constructor wrappers --- Examples/test-suite/doxygen_nested_class.i | 1 + Examples/test-suite/doxygen_parsing.i | 1 + Examples/test-suite/java/CommentParser.java | 4 ++++ .../test-suite/java/doxygen_nested_class_runme.java | 10 ++++++---- Examples/test-suite/java/doxygen_parsing_runme.java | 6 ++++++ Examples/test-suite/python/doxygen_parsing_runme.py | 2 ++ 6 files changed, 20 insertions(+), 4 deletions(-) diff --git a/Examples/test-suite/doxygen_nested_class.i b/Examples/test-suite/doxygen_nested_class.i index 2078392c4..91218e2bc 100644 --- a/Examples/test-suite/doxygen_nested_class.i +++ b/Examples/test-suite/doxygen_nested_class.i @@ -7,6 +7,7 @@ struct DoxOuter { /** DoxOuter constructor */ DoxOuter() {} + /** DoxInner class description */ struct DoxInner { /** DoxInner constructor */ DoxInner() {} diff --git a/Examples/test-suite/doxygen_parsing.i b/Examples/test-suite/doxygen_parsing.i index 7ff19ecfa..21b51bc51 100644 --- a/Examples/test-suite/doxygen_parsing.i +++ b/Examples/test-suite/doxygen_parsing.i @@ -41,6 +41,7 @@ int someVar=42; */ #define CONSTANT_VALUE 4242 +/// SomeAnotherClass description class SomeAnotherClass { public: diff --git a/Examples/test-suite/java/CommentParser.java b/Examples/test-suite/java/CommentParser.java index c8adc1d1e..7dc6d591d 100644 --- a/Examples/test-suite/java/CommentParser.java +++ b/Examples/test-suite/java/CommentParser.java @@ -34,6 +34,10 @@ public class CommentParser { if (f.getRawCommentText().length() > 0) 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()) { if (m.getRawCommentText().length() > 0) m_parsedComments.put(m.toString(), m.getRawCommentText()); diff --git a/Examples/test-suite/java/doxygen_nested_class_runme.java b/Examples/test-suite/java/doxygen_nested_class_runme.java index 1c6e64a4f..3ffa796f0 100644 --- a/Examples/test-suite/java/doxygen_nested_class_runme.java +++ b/Examples/test-suite/java/doxygen_nested_class_runme.java @@ -25,10 +25,12 @@ public class doxygen_nested_class_runme { HashMap wantedComments = new HashMap(); -// wantedComments.put("doxygen_nested_class.DoxOuter.DoxOuter()", -// " DoxOuter constructor "); -// wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner.DoxInner()", -// " DoxInner constructor "); + wantedComments.put("doxygen_nested_class.DoxOuter()", + " DoxOuter constructor "); + wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner", + " DoxInner class description "); + wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner()", + " DoxInner constructor "); wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner.setDoxInt(int)", " doxInt variable "); wantedComments.put("doxygen_nested_class.DoxOuter.DoxInner.getDoxInt()", diff --git a/Examples/test-suite/java/doxygen_parsing_runme.java b/Examples/test-suite/java/doxygen_parsing_runme.java index 167010544..d58b1f486 100644 --- a/Examples/test-suite/java/doxygen_parsing_runme.java +++ b/Examples/test-suite/java/doxygen_parsing_runme.java @@ -26,6 +26,12 @@ public class doxygen_parsing_runme { HashMap wantedComments = new HashMap(); + 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()", " The class attribute comment \n" + " \n" + diff --git a/Examples/test-suite/python/doxygen_parsing_runme.py b/Examples/test-suite/python/doxygen_parsing_runme.py index 14579281d..f09f50761 100644 --- a/Examples/test-suite/python/doxygen_parsing_runme.py +++ b/Examples/test-suite/python/doxygen_parsing_runme.py @@ -11,6 +11,8 @@ comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeClass), "The class comment") comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeStruct), "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 # using "-builtin" (see http://stackoverflow.com/q/11913492/15275), so skip