test.c: Add unit test registration checks for summary and description.

Added checks when a unit test is registered to see that the summary and
description strings do not end with a new-line '\n' for consistency.

The check generates a warning message and will cause the
/main/test/registrations unit test to fail.

* Updated struct ast_test_info member doxygen comments.

Change-Id: I295909b6bc013ed9b6882e85c05287082497534d
This commit is contained in:
Richard Mudgett
2015-06-24 14:30:15 -05:00
parent 2b0482d699
commit 2602a7484b
2 changed files with 39 additions and 10 deletions

View File

@@ -224,13 +224,22 @@ struct ast_test_info {
/*!
* \brief test category
*
* \details
* Tests are categorized in a directory tree style hierarchy. It is expected that
* this string have both a leading and trailing forward slash ('/').
*/
const char *category;
/*! \brief optional short summary of test */
/*!
* \brief Short summary of test
*
* \note The summary must not end with a newline.
*/
const char *summary;
/*! \brief optional brief detailed description of test */
/*!
* \brief More detailed description of test
*
* \note The description must not end with a newline.
*/
const char *description;
};