Don't indent Doxygen doc strings in generated Python code.

This is unnecessary and inconsistent with "builtin" case in which the
docstrings are not indented in the generated C++ code, thus making it
impossible to write tests working in both cases.

Most of the changes in this commit simply remove the extra whitespace from the
expected values in the tests.
This commit is contained in:
Vadim Zeitlin 2014-12-15 12:58:03 +01:00
commit 410b508e9a
9 changed files with 471 additions and 535 deletions

View file

@ -7,75 +7,68 @@ import commentVerifier
commentVerifier.check(doxygen_basic_notranslate.function.__doc__,
r"""
\brief
Brief description.
The comment text
\author Some author
\return Some number
\sa function2
"""
\brief
Brief description.
The comment text
\author Some author
\return Some number
\sa function2
"""
)
commentVerifier.check(doxygen_basic_notranslate.function2.__doc__,
r"""
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.
"""
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_notranslate.function3.__doc__,
r"""
*Overload 1:*
r""" *Overload 1:*
A test for overloaded functions
This is function \b one
A test for overloaded functions
This is function \b one
|
|
*Overload 2:*
*Overload 2:*
A test for overloaded functions
This is function \b two
"""
A test for overloaded functions
This is function \b two"""
)
commentVerifier.check(doxygen_basic_notranslate.function4.__doc__,
r"""
A test of some mixed tag usage
\if CONDITION
This \a code fragment shows us something \.
\par Minuses:
\arg it's senseless
\arg it's stupid
\arg it's null
A test of some mixed tag usage
\if CONDITION
This \a code fragment shows us something \.
\par Minuses:
\arg it's senseless
\arg it's stupid
\arg it's null
\warning This may not work as expected
\warning This may not work as expected
\code
int main() { while(true); }
\endcode
\endif
"""
\code
int main() { while(true); }
\endcode
\endif
"""
)
commentVerifier.check(doxygen_basic_notranslate.function5.__doc__,
r""" This is a post comment. """
)
commentVerifier.check(doxygen_basic_notranslate.function6.__doc__,
r"""
Test for default args
@param a Some parameter, default is 42
"""
Test for default args
@param a Some parameter, default is 42
"""
)
commentVerifier.check(doxygen_basic_notranslate.function7.__doc__,
r"""
Test for a parameter with difficult type
(mostly for python)
@param a Very strange param
"""
Test for a parameter with difficult type
(mostly for python)
@param a Very strange param
"""
)