8b83976f4c
For the parameter documentation to be really taken as such, in its entirety, by Sphinx, it must be indented relative to the :param: tag. Do this by appending an extra indent after every line of the output and work around the unnecessary indent of the last line by removing the trailing whitespace. This required updating the existing tests and removing the expected but not present any more whitespace from them, but as trailing whitespace in the documentation is at best insignificant (and at worst harmful) anyhow, this is not a big price to pay for simpler translator code.
77 lines
1.6 KiB
Python
77 lines
1.6 KiB
Python
#!/usr/bin/python
|
|
|
|
import doxygen_basic_translate
|
|
import string
|
|
import sys
|
|
import commentVerifier
|
|
|
|
commentVerifier.check(doxygen_basic_translate.function.__doc__,
|
|
"""
|
|
Brief description.
|
|
|
|
The comment text.
|
|
|
|
Author: Some author
|
|
|
|
:return: Some number
|
|
|
|
See also: function2
|
|
"""
|
|
)
|
|
commentVerifier.check(doxygen_basic_translate.function2.__doc__,
|
|
"""
|
|
A test of a very very very very very very very very very very very very very very very very
|
|
very very very very very long comment string.
|
|
"""
|
|
)
|
|
commentVerifier.check(doxygen_basic_translate.function3.__doc__,
|
|
"""
|
|
*Overload 1:*
|
|
|
|
A test for overloaded functions
|
|
This is function **one**
|
|
|
|
*Overload 2:*
|
|
|
|
A test for overloaded functions
|
|
This is function **two**
|
|
|
|
"""
|
|
)
|
|
commentVerifier.check(doxygen_basic_translate.function4.__doc__,
|
|
"""
|
|
A test of some mixed tag usage
|
|
If: CONDITION {
|
|
This *code* fragment shows us something .
|
|
Title: Minuses:
|
|
* it\'s senseless
|
|
* it\'s stupid
|
|
* it\'s null
|
|
|
|
Warning: This may not work as expected
|
|
|
|
int main() { while(true); }
|
|
|
|
}
|
|
"""
|
|
)
|
|
commentVerifier.check(doxygen_basic_translate.function5.__doc__,
|
|
"""
|
|
This is a post comment.
|
|
"""
|
|
)
|
|
commentVerifier.check(doxygen_basic_translate.function6.__doc__,
|
|
"""
|
|
Test for default args
|
|
: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)
|
|
:type a: Shape
|
|
:param a: Very strange param
|
|
"""
|
|
)
|