updated test doxygen_misc_constructs for Python
This commit is contained in:
parent
29d1bba70a
commit
ee3e4024a6
2 changed files with 70 additions and 1 deletions
|
|
@ -8,8 +8,13 @@ def check(got, expected):
|
||||||
#expectedStr = string.replace(expected, ' ', '')
|
#expectedStr = string.replace(expected, ' ', '')
|
||||||
#expectedStr = string.replace(expectedStr, '\n', '')
|
#expectedStr = string.replace(expectedStr, '\n', '')
|
||||||
#expectedStr = string.replace(expectedStr, '\t', '')
|
#expectedStr = string.replace(expectedStr, '\t', '')
|
||||||
|
|
||||||
|
if got == None: # when there is no commant attached to a class or function
|
||||||
|
got = ''
|
||||||
|
|
||||||
if not got == expected:
|
if not got == expected:
|
||||||
print "\n\n////////////////////////////////////////////////////////////////////////"
|
print "\n\n////////////////////////////////////////////////////////////////////////"
|
||||||
|
|
||||||
expectedFileName = "expected.txt"
|
expectedFileName = "expected.txt"
|
||||||
gotFileName = "got.txt"
|
gotFileName = "got.txt"
|
||||||
print "Output is also saved to files '" + expectedFileName + \
|
print "Output is also saved to files '" + expectedFileName + \
|
||||||
|
|
|
||||||
|
|
@ -41,8 +41,72 @@ commentVerifier.check(doxygen_misc_constructs.waitTime.__doc__,
|
||||||
may be specified.
|
may be specified.
|
||||||
"""
|
"""
|
||||||
)
|
)
|
||||||
|
|
||||||
commentVerifier.check(doxygen_misc_constructs.getConnection.__doc__,
|
commentVerifier.check(doxygen_misc_constructs.getConnection.__doc__,
|
||||||
r"""
|
r"""
|
||||||
This function returns connection id.
|
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)
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue