Adding test for second doxygen comment style
This style looks like: /** Line 1 * Line 2 */ This is needed to verify fixes to some of the indentation in the translated comments. The test is copied from doxygen_basic_translate.i. One adjustment was made to change the comment style on the last function that left out the intermediate "*" characters. This does not produce correct output when combined with this style of starting the text on the first comment line. Test results are copied directly from doxygen_basic_translate. A minor difference in the Python results will be updated in a subsequent commit.
This commit is contained in:
parent
98ae66b6fc
commit
91a90b8d27
4 changed files with 287 additions and 0 deletions
|
|
@ -0,0 +1,82 @@
|
|||
import doxygen_basic_translate_spaced
|
||||
import inspect
|
||||
import string
|
||||
import sys
|
||||
import comment_verifier
|
||||
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_spaced.function),
|
||||
"""\
|
||||
Brief description.
|
||||
|
||||
The comment text.
|
||||
|
||||
Author: Some author
|
||||
|
||||
:rtype: int
|
||||
:return: Some number
|
||||
|
||||
See also: function2"""
|
||||
)
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_spaced.function2),
|
||||
"""\
|
||||
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."""
|
||||
)
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_spaced.function3),
|
||||
"""*Overload 1:*
|
||||
|
||||
A test for overloaded functions
|
||||
This is function **one**
|
||||
|
||||
|
|
||||
|
||||
*Overload 2:*
|
||||
|
||||
A test for overloaded functions
|
||||
This is function **two**"""
|
||||
)
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_spaced.function4),
|
||||
"""\
|
||||
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
|
||||
|
||||
.. code-block:: c++
|
||||
|
||||
int main() { while(true); }
|
||||
}"""
|
||||
)
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_spaced.function5),
|
||||
"""This is a post comment."""
|
||||
)
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_spaced.function6),
|
||||
"""\
|
||||
Test for default args
|
||||
:type a: int
|
||||
:param a: Some parameter, default is 42"""
|
||||
)
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_spaced.function7),
|
||||
"""\
|
||||
Test for a parameter with difficult type
|
||||
(mostly for python)
|
||||
:type a: :py:class:`Shape`
|
||||
:param a: Very strange param"""
|
||||
)
|
||||
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_spaced.Atan2),
|
||||
"""\
|
||||
Multiple parameters test.
|
||||
|
||||
:type y: float
|
||||
:param y: Vertical coordinate.
|
||||
:type x: float
|
||||
:param x: Horizontal coordinate.
|
||||
:rtype: float
|
||||
:return: Arc tangent of ``y/x``."""
|
||||
)
|
||||
Loading…
Add table
Add a link
Reference in a new issue