diff --git a/Examples/test-suite/python/commentVerifier.py b/Examples/test-suite/python/commentVerifier.py index 8a73b1950..f7c0114ee 100644 --- a/Examples/test-suite/python/commentVerifier.py +++ b/Examples/test-suite/python/commentVerifier.py @@ -8,8 +8,13 @@ def check(got, expected): #expectedStr = string.replace(expected, ' ', '') #expectedStr = string.replace(expectedStr, '\n', '') #expectedStr = string.replace(expectedStr, '\t', '') + + if got == None: # when there is no commant attached to a class or function + got = '' + if not got == expected: print "\n\n////////////////////////////////////////////////////////////////////////" + expectedFileName = "expected.txt" gotFileName = "got.txt" print "Output is also saved to files '" + expectedFileName + \ @@ -20,5 +25,5 @@ def check(got, expected): expectedFile.close() gotFile = open(gotFileName, "w") gotFile.write(got) - gotFile.close() + gotFile.close() raise RuntimeError("Expected: [" + str(expected) + "]\n" + "Got : [" + str(got) + "]\n") diff --git a/Examples/test-suite/python/doxygen_misc_constructs_runme.py b/Examples/test-suite/python/doxygen_misc_constructs_runme.py index 55b4a7ef6..d2f04a874 100755 --- a/Examples/test-suite/python/doxygen_misc_constructs_runme.py +++ b/Examples/test-suite/python/doxygen_misc_constructs_runme.py @@ -41,8 +41,72 @@ commentVerifier.check(doxygen_misc_constructs.waitTime.__doc__, may be specified. """ ) + commentVerifier.check(doxygen_misc_constructs.getConnection.__doc__, r""" This function returns connection id. """ ) + + +commentVerifier.check(doxygen_misc_constructs.getFirstLetter.__doc__, + r'' +) + +commentVerifier.check(doxygen_misc_constructs.ClassWithNestedEnum.__doc__, + r""" + Class description. + """ +) + +commentVerifier.check(doxygen_misc_constructs.isNoSpaceValidA.__doc__, + r""" + This comment without space after '*' is valid in Doxygen. + + """ +) + +commentVerifier.check(doxygen_misc_constructs.isNoSpaceValidB.__doc__, + r""" + .This comment without space after '*' is valid in Doxygen. + + """ +) + +commentVerifier.check(doxygen_misc_constructs.isNoSpaceValidC.__doc__, + r'' +) + +commentVerifier.check(doxygen_misc_constructs.backslashA.__doc__, + r""" + Backslash following'word' is a valid doxygen command. Output contains + 'followingword' with 'word' in code font. + """ +) + +commentVerifier.check(doxygen_misc_constructs.backslashB.__doc__, + r""" + Doxy command without trailing space is ignored - nothing appears + on output. Standalone \ and '\' get to output. + Standalone @ and '@' get to output. + Commands "in quoted \b strings are treated as plain text". + Commands not recognized by Doxygen are ignored. + Backslashes in DOS paths d:and words + following them do not appear on output, we must quote them with + double quotes: "d:\xyz\qwe\myfile", "@something". Single quotes do not help: + 'd:'. Escaping works: d:\xyz\qwe\myfile. Unix + paths of course have no such problems: /xyz/qwe/myfile + Commands for escaped symbols: + $ @ \ & ~ < > # % " . :: @text ::text + """ +) + +commentVerifier.check(doxygen_misc_constructs.backslashC.__doc__, + r""" + Backslash e at end of _line_ froze SWIG + _with_ old comment parser. + + See also: MyClass::fun(char, + float) + """ +)