aboutsummaryrefslogtreecommitdiffstats
path: root/include/asterisk/test.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/asterisk/test.h')
-rw-r--r--include/asterisk/test.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/include/asterisk/test.h b/include/asterisk/test.h
index f97df80d7..57e05b471 100644
--- a/include/asterisk/test.h
+++ b/include/asterisk/test.h
@@ -154,7 +154,12 @@ struct ast_test;
struct ast_test_info {
/*! \brief name of test, unique to category */
const char *name;
- /*! \brief test category */
+ /*!
+ * \brief test category
+ *
+ * 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 */
const char *summary;