diff options
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; }; |