[svn-commits] dvossel: branch dvossel/test_api r235137 - /team/dvossel/test_api/include/ast...

[SVN commits to the Digium repositories]

Author: dvossel
Date: Tue Dec 15 13:09:30 2009
New Revision: 235137

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=235137
Log:
additional AST_TEST_DEFINE documentation

Modified:
    team/dvossel/test_api/include/asterisk/test.h

Modified: team/dvossel/test_api/include/asterisk/test.h
URL: http://svnview.digium.com/svn/asterisk/team/dvossel/test_api/include/asterisk/test.h?view=diff&rev=235137&r1=235136&r2=235137
==============================================================================
--- team/dvossel/test_api/include/asterisk/test.h (original)
+++ team/dvossel/test_api/include/asterisk/test.h Tue Dec 15 13:09:30 2009
@@ -36,7 +36,13 @@
 	return res ? AST_RESULT_FAIL : AST_RESULT_PASS;
 })
 
-Every callback function is passed a char buffer which allows
+NOTE: It is possible for a ',' within the code body to mess up the macro
+depending on how it is used.  If this happens (code won't compile) and can
+not be avoided, a separate static function must be created to hold
+the test's code.  In this case the callback's message body should just contain
+a call to the static function.
+
+Every callback function is passed a string buffer which allows
 the function to provide an optional short description of
 what went wrong if the test failed.