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:
parent
329d64bb04
commit
b374aad0da
7 changed files with 94 additions and 66 deletions
|
|
@ -13,7 +13,7 @@ commentVerifier.check(doxygen_basic_translate.function.__doc__,
|
|||
|
||||
Author: Some author
|
||||
|
||||
Return: Some number
|
||||
:return: Some number
|
||||
|
||||
See also: function2
|
||||
"""
|
||||
|
|
@ -65,15 +65,15 @@ commentVerifier.check(doxygen_basic_translate.function5.__doc__,
|
|||
commentVerifier.check(doxygen_basic_translate.function6.__doc__,
|
||||
"""
|
||||
Test for default args
|
||||
Arguments:
|
||||
a (int) -- Some parameter, default is 42
|
||||
:type a: int
|
||||
:param a: Some parameter, default is 42
|
||||
"""
|
||||
)
|
||||
commentVerifier.check(doxygen_basic_translate.function7.__doc__,
|
||||
"""
|
||||
Test for a parameter with difficult type
|
||||
(mostly for python)
|
||||
Arguments:
|
||||
a (Shape::superType *[10]) -- Very strange param
|
||||
:type a: Shape::superType *[10]
|
||||
:param a: Very strange param
|
||||
"""
|
||||
)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue