Add new test doxygen_basic_translate_style3.i

This is used to test the "///" style of doxygen comments.  Previously,
newlines in these doxygen comments were not handled correctly.
This commit is contained in:
John McFarland 2019-10-30 18:39:23 -05:00
commit feea39f352
4 changed files with 279 additions and 0 deletions

View file

@ -0,0 +1,95 @@
%module doxygen_basic_translate_style3
%include "doxygen_basic_translate.h"
%inline %{
/// \brief
/// Brief description.
///
/// The comment text.
///
/// \author Some author
///
/// \return Some number
///
/// \sa function2
int function()
{
return 0;
}
/// 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.
void function2()
{
}
/// A test for overloaded functions
/// This is function \b one
void function3(int a)
{
}
/// A test for overloaded functions
/// This is function \b two
void function3(int a, int b)
{
}
/// 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
/// \code
/// int main() { while(true); }
///
/// // Test blank line in code block
/// \endcode
/// \endif
void function4()
{
}
void function5(int a)
{
}
///< This is a post comment.
/// Test for default args
/// @param a Some parameter, default is 42
void function6(int a=42)
{
}
class Shape
{
public:
typedef Shape* superType;
};
/// Test for a parameter with difficult type
/// (mostly for python)
/// @param a Very strange param
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.
%}