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:12:19 -0500 |
commit | 2602a7484be67353ac70691e7e75a54983d4d773 (patch) | |
tree | 7b0592318b073e8081bffa4f5ab9fb4fbe11960e /include | |
parent | 2b0482d699e44d1f4159bd68d30b2a6a80d21ca8 (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')
-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; }; |