64b2113e66
The _runme.py code for the recently added test case was using references to an old module name for the test case, which was later changed but not updated in the runme file.
80 lines
1.8 KiB
Python
80 lines
1.8 KiB
Python
import doxygen_basic_translate_style2
|
|
import inspect
|
|
import string
|
|
import sys
|
|
import comment_verifier
|
|
|
|
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_style2.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_style2.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_style2.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_style2.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_style2.function5),
|
|
"""This is a post comment."""
|
|
)
|
|
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_style2.function6),
|
|
"""\
|
|
Test for default args
|
|
:type a: int
|
|
:param a: Some parameter, default is 42"""
|
|
)
|
|
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_style2.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_style2.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``."""
|
|
)
|