diff options
author | Richard Mudgett <rmudgett@digium.com> | 2015-06-24 14:30:15 -0500 |
---|---|---|
committer | Richard Mudgett <rmudgett@digium.com> | 2015-06-24 17:13:31 -0500 |
commit | daaa551c92a793f95ec24198d8b62fc09618f035 (patch) | |
tree | 9504cb2dfb340ffd04886cd7e04e64f0d1c80e5b /include/asterisk/test.h | |
parent | 71a4d1a033548f0f2bdfa0f42522f2c65f84e257 (diff) |
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
Diffstat (limited to 'include/asterisk/test.h')
-rw-r--r-- | include/asterisk/test.h | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/include/asterisk/test.h b/include/asterisk/test.h index 69f88374e..49731feb6 100644 --- a/include/asterisk/test.h +++ b/include/asterisk/test.h @@ -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; }; |