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

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;