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:
parent
bb01e06a6a
commit
0f21adf3f9
3 changed files with 33 additions and 2 deletions
|
|
@ -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.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -85,8 +85,15 @@ public class doxygen_basic_translate_runme {
|
|||
" This is function <b>two </b>\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
|
||||
System.exit(parser.check(wantedComments));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -75,3 +75,15 @@ commentVerifier.check(doxygen_basic_translate.function7.__doc__,
|
|||
: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``.
|
||||
"""
|
||||
)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue