diff options
author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-07-09 15:33:08 +0000 |
---|---|---|
committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-07-09 15:33:08 +0000 |
commit | 95f27c617a536a2e5b20d6684ad7ddd803001489 (patch) | |
tree | 5ce6ea50854c28d93da3f5a1a46e61a16d1e0ce7 /include | |
parent | d34a29083c359d5177f3db0818073479c120c877 (diff) |
Document that a leading and trailing slash is expected for test categories.
Also, emit a warning if a test is registered without one of these.
git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@275021 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include')
-rw-r--r-- | include/asterisk/test.h | 7 |
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; |