Add a simple test of multiple parameters to Doxygen test suite.

Ensure that translating more than one @param tag works correctly.
This commit is contained in:
Vadim Zeitlin 2014-08-05 01:48:49 +02:00
commit 0f21adf3f9
3 changed files with 33 additions and 2 deletions

View file

@ -92,6 +92,18 @@ void function7(Shape::superType *a[10])
{ {
} }
/**
Multiple parameters test.
@param y Vertical coordinate.
@param x Horizontal coordinate.
@return Arc tangent of @c y/x.
*/
double Atan2(double y, double x)
{
return 0;
}
/** /**
* Comment at the end of file should be ignored. * Comment at the end of file should be ignored.
*/ */

View file

@ -85,6 +85,13 @@ public class doxygen_basic_translate_runme {
" This is function <b>two </b>\n" + " This is function <b>two </b>\n" +
" \n" + " \n" +
""); "");
wantedComments.put("doxygen_basic_translate.doxygen_basic_translate.Atan2(double, double)",
" Multiple parameters test.\n" +
" \n" +
" @param y Vertical coordinate.\n" +
" @param x Horizontal coordinate.\n" +
" @return Arc tangent of <code>y/x</code>.\n" +
"");
// and ask the parser to check comments for us // and ask the parser to check comments for us
System.exit(parser.check(wantedComments)); System.exit(parser.check(wantedComments));

View file

@ -75,3 +75,15 @@ commentVerifier.check(doxygen_basic_translate.function7.__doc__,
:param a: Very strange param :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.
:return: Arc tangent of ``y/x``.
"""
)