1f826b0925
The most important change is to ensure that the "Overload" headers added by PyDocConverter code are indented correctly, i.e. using the same indent level as the comment itself, otherwise Sphinx directives such as :param: were not parsed correctly. Also add a vertical separator using reST "|" formatting character to increase separation between the overloads.
78 lines
1.9 KiB
Python
78 lines
1.9 KiB
Python
#!/usr/bin/python
|
|
|
|
import doxygen_parsing
|
|
import string
|
|
import sys
|
|
import commentVerifier
|
|
|
|
commentVerifier.check(doxygen_parsing.someFunction.__doc__,
|
|
r"""
|
|
The function comment
|
|
""")
|
|
commentVerifier.check(doxygen_parsing.SomeClass.__doc__,
|
|
r"""
|
|
The class comment
|
|
""")
|
|
commentVerifier.check(doxygen_parsing.SomeStruct.__doc__,
|
|
r"""
|
|
The struct comment
|
|
""")
|
|
commentVerifier.check(doxygen_parsing.SomeAnotherClass.__init__.__doc__,
|
|
r"""
|
|
*Overload 1:*
|
|
First overloaded constructor.
|
|
|
|
|
|
|
|
|
*Overload 2:*
|
|
Second overloaded constructor.
|
|
""")
|
|
commentVerifier.check(doxygen_parsing.SomeAnotherClass.classMethod.__doc__,
|
|
r"""
|
|
The class method comment.
|
|
|
|
SomeAnotherClass#classMethodExtended(int, int) a link text
|
|
""")
|
|
commentVerifier.check(doxygen_parsing.SomeAnotherClass.classMethodExtended.__doc__,
|
|
r"""
|
|
The class method with parameter
|
|
|
|
:type a: int
|
|
:param a: Parameter a
|
|
:type b: int
|
|
:param b: Parameter b
|
|
"""
|
|
)
|
|
commentVerifier.check(doxygen_parsing.SomeAnotherClass.classMethodExtended2.__doc__,
|
|
r"""
|
|
The class method with parameter
|
|
|
|
:type a: int
|
|
:param a: Parameter a
|
|
:type b: int
|
|
:param b: Parameter b
|
|
"""
|
|
)
|
|
commentVerifier.check(doxygen_parsing.SomeAnotherStruct.structMethod.__doc__,
|
|
r"""
|
|
The struct method comment
|
|
""")
|
|
commentVerifier.check(doxygen_parsing.SomeAnotherStruct.structMethodExtended.__doc__,
|
|
r"""
|
|
The struct method with parameter
|
|
|
|
:type a: int
|
|
:param a: Parameter a
|
|
:type b: int
|
|
:param b: Parameter b
|
|
"""
|
|
)
|
|
commentVerifier.check(doxygen_parsing.SomeAnotherStruct.structMethodExtended2.__doc__,
|
|
r"""
|
|
The struct method with parameter
|
|
|
|
:type a: int
|
|
:param a: Parameter a
|
|
:type b: int
|
|
:param b: Parameter b
|
|
""")
|