Fix missing returns in the Doxygen test suite code.

Missing returns resulted in test suite failures now that it is built with
-Wreturn-type, so avoid them by simply making most of the functions void and
adding explicit return statements to a couple of them that used Doxygen
\return command in their documentation, which doesn't make sense for the void
functions.
This commit is contained in:
Vadim Zeitlin 2015-02-17 18:32:56 +01:00
parent 45ecc9cb84
commit 2e5017c6ef
6 changed files with 32 additions and 29 deletions

View File

@ -22,13 +22,14 @@
*/ */
int function() int function()
{ {
return 0;
} }
/** /**
* A test of a very very very very very very very very very very very very very very very very * 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. * very very very very very long comment string.
*/ */
int function2() void function2()
{ {
} }
@ -36,7 +37,7 @@ int function2()
* A test for overloaded functions * A test for overloaded functions
* This is function \b one * This is function \b one
*/ */
int function3(int a) void function3(int a)
{ {
} }
@ -44,7 +45,7 @@ int function3(int a)
* A test for overloaded functions * A test for overloaded functions
* This is function \b two * This is function \b two
*/ */
int function3(int a, int b) void function3(int a, int b)
{ {
} }
@ -64,12 +65,12 @@ int function3(int a, int b)
* \endcode * \endcode
* \endif * \endif
*/ */
int function4() void function4()
{ {
} }
int function5(int a) void function5(int a)
{ {
} }
/**< This is a post comment. */ /**< This is a post comment. */
@ -78,7 +79,7 @@ int function5(int a)
* Test for default args * Test for default args
* @param a Some parameter, default is 42 * @param a Some parameter, default is 42
*/ */
int function6(int a=42) void function6(int a=42)
{ {
} }

View File

@ -18,13 +18,14 @@
*/ */
int function() int function()
{ {
return 0;
} }
/** /**
* A test of a very very very very very very very very very very very very very very very very * 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. * very very very very very long comment string.
*/ */
int function2() void function2()
{ {
} }
@ -32,7 +33,7 @@ int function2()
* A test for overloaded functions * A test for overloaded functions
* This is function \b one * This is function \b one
*/ */
int function3(int a) void function3(int a)
{ {
} }
@ -40,7 +41,7 @@ int function3(int a)
* A test for overloaded functions * A test for overloaded functions
* This is function \b two * This is function \b two
*/ */
int function3(int a, int b) void function3(int a, int b)
{ {
} }
@ -59,12 +60,12 @@ int function3(int a, int b)
* \endcode * \endcode
* \endif * \endif
*/ */
int function4() void function4()
{ {
} }
int function5(int a) void function5(int a)
{ {
} }
/**< This is a post comment. */ /**< This is a post comment. */
@ -73,7 +74,7 @@ int function5(int a)
* Test for default args * Test for default args
* @param a Some parameter, default is 42 * @param a Some parameter, default is 42
*/ */
int function6(int a=42) void function6(int a=42)
{ {
} }

View File

@ -123,6 +123,7 @@
*/ */
int function(int a, float b) int function(int a, float b)
{ {
return 0;
} }
/** /**
@ -205,7 +206,7 @@ int function(int a, float b)
* <u>underlined \b bold text - doxy commands are ignored inside 'htmlonly' section </u> * <u>underlined \b bold text - doxy commands are ignored inside 'htmlonly' section </u>
* \endhtmlonly * \endhtmlonly
*/ */
int htmlFunction(int a, float b) void htmlFunction(int a, float b)
{ {
} }
@ -222,7 +223,7 @@ int htmlFunction(int a, float b)
* Almost all combinations of above flags are supported by * Almost all combinations of above flags are supported by
* \c htmlTable... functions. * \c htmlTable... functions.
*/ */
int htmlTableFunction(int byFlags) void htmlTableFunction(int byFlags)
{ {
} }
@ -252,7 +253,7 @@ int htmlTableFunction(int byFlags)
* Not an &text; html entity - ignored by Doxygen. * Not an &text; html entity - ignored by Doxygen.
* Not an &text html entity - ampersand is replaced with entity. * Not an &text html entity - ampersand is replaced with entity.
*/ */
int htmlEntitiesFunction(int a, float b) void htmlEntitiesFunction(int a, float b)
{ {
} }

View File

@ -35,7 +35,7 @@
* \class someClass headerFile.h headerName * \class someClass headerFile.h headerName
* \code some test code \endcode * \code some test code \endcode
*/ */
int func01(int a) void func01(int a)
{ {
} }
@ -64,7 +64,7 @@ int func01(int a)
* \details This is very large * \details This is very large
* and detailed description of some thing * and detailed description of some thing
*/ */
int func02(int a) void func02(int a)
{ {
} }
@ -96,7 +96,7 @@ int func02(int a)
* \example someFile.txt * \example someFile.txt
* Some details on using the example * Some details on using the example
*/ */
int func03(int a) void func03(int a)
{ {
} }
@ -131,7 +131,7 @@ int func03(int a)
* This will only appear in hmtl * This will only appear in hmtl
* \endhtmlonly * \endhtmlonly
*/ */
int func04(int a) void func04(int a)
{ {
} }
@ -172,7 +172,7 @@ int func04(int a)
* \invariant Some text * \invariant Some text
* describing invariant. * describing invariant.
*/ */
int func05(int a) void func05(int a)
{ {
} }
@ -216,7 +216,7 @@ int func05(int a)
* *
* \n \n \n * \n \n \n
*/ */
int func06(int a) void func06(int a)
{ {
} }
@ -259,7 +259,7 @@ int func06(int a)
* *
* \property someVar * \property someVar
*/ */
int func07(int a) void func07(int a)
{ {
} }
@ -303,7 +303,7 @@ int func07(int a)
* *
* \retval someValue Some description * \retval someValue Some description
*/ */
int func08(int a) void func08(int a)
{ {
} }
@ -350,7 +350,7 @@ int func08(int a)
* *
* \throws RuntimeError * \throws RuntimeError
*/ */
int func09(int a) void func09(int a)
{ {
} }
@ -392,7 +392,7 @@ int func09(int a)
* *
* And here goes simple text * And here goes simple text
*/ */
int func10(int a, float b) void func10(int a, float b)
{ {
} }

View File

@ -44,7 +44,7 @@ public:
* \sa superFunc() * \sa superFunc()
* *
*/ */
int function() void function()
{ {
} }

View File

@ -262,13 +262,13 @@ Remarks: Some remark text
Another remarks section Another remarks section
:rtype: int :rtype: void
:return: Whatever :return: Whatever
:rtype: int :rtype: void
:return: it :return: it
:rtype: int :rtype: void
:return: may return :return: may return
""") """)