Use Sphinx-compatible docstring format in PyDocConverter.

Use the more or less standard :param:, :type:, :return: and :raises: in the
function/methods descriptions.

Update the output expected from the Python tests accordingly.
This commit is contained in:
Vadim Zeitlin 2014-06-15 23:42:41 +02:00
commit b374aad0da
7 changed files with 94 additions and 66 deletions

View file

@ -27,18 +27,20 @@ commentVerifier.check(doxygen_parsing.SomeAnotherClass.classMethodExtended.__doc
r"""
The class method with parameter
Arguments:
a (int) -- Parameter a
b (int) -- Parameter b
: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
Arguments:
a (int) -- Parameter a
b (int) -- Parameter b
:type a: int
:param a: Parameter a
:type b: int
:param b: Parameter b
"""
)
commentVerifier.check(doxygen_parsing.SomeAnotherStruct.structMethod.__doc__,
@ -49,16 +51,18 @@ commentVerifier.check(doxygen_parsing.SomeAnotherStruct.structMethodExtended.__d
r"""
The struct method with parameter
Arguments:
a (int) -- Parameter a
b (int) -- Parameter b
: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
Arguments:
a (int) -- Parameter a
b (int) -- Parameter b
:type a: int
:param a: Parameter a
:type b: int
:param b: Parameter b
""")