7d2743a0bb
reST is standard Python markup, so use *...*, ``...`` and so on instead of _..._, '...' etc. No other changes even though the mapping of some Doxygen tags to markup used for them seems suspicions (e.g. \var almost certainly should be the same as \em).
79 lines
1.9 KiB
Python
79 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
|
|
|
|
: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::superType *[10]
|
|
:param a: Very strange param
|
|
"""
|
|
)
|