6aa9cd37a5
In addition to translating the comment itself, also document the type of the object returned. This is consistent with generating not only :param: but also :type: for the parameters documented using @param.
93 lines
1.9 KiB
Python
93 lines
1.9 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
|
|
|
|
:rtype: int
|
|
: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
|
|
|
|
.. code-block:: c++
|
|
|
|
|
|
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: :py:class:`Shape`
|
|
:param a: Very strange param
|
|
"""
|
|
)
|
|
|
|
commentVerifier.check(doxygen_basic_translate.Atan2.__doc__,
|
|
"""
|
|
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``.
|
|
"""
|
|
)
|