mirror of https://github.com/swig/swig
67 lines
2.0 KiB
Python
67 lines
2.0 KiB
Python
import doxygen_parsing
|
|
import inspect
|
|
import string
|
|
import os
|
|
import sys
|
|
import comment_verifier
|
|
|
|
comment_verifier.check(inspect.getdoc(doxygen_parsing.someFunction),
|
|
"The function comment")
|
|
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
|
|
# this test in this case.
|
|
if not doxygen_parsing.is_python_builtin():
|
|
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.__init__),
|
|
r"""*Overload 1:*
|
|
First overloaded constructor.
|
|
|
|
|
|
|
|
|
*Overload 2:*
|
|
Second overloaded constructor.""")
|
|
|
|
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMethod),
|
|
r"""The class method comment.
|
|
|
|
SomeAnotherClass#classMethodExtended(int, int) a link text""")
|
|
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMethodExtended),
|
|
r"""The class method with parameter
|
|
|
|
:type a: int
|
|
:param a: Parameter a
|
|
:type b: int
|
|
:param b: Parameter b"""
|
|
)
|
|
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMethodExtended2),
|
|
r"""The class method with parameter
|
|
|
|
:type a: int
|
|
:param a: Parameter a
|
|
:type b: int
|
|
:param b: Parameter b"""
|
|
)
|
|
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMethod),
|
|
r"""The struct method comment""")
|
|
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMethodExtended),
|
|
r"""The struct method with parameter
|
|
|
|
:type a: int
|
|
:param a: Parameter a
|
|
:type b: int
|
|
:param b: Parameter b"""
|
|
)
|
|
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMethodExtended2),
|
|
r"""The struct method with parameter
|
|
|
|
:type a: int
|
|
:param a: Parameter a
|
|
:type b: int
|
|
:param b: Parameter b""")
|