[asterisk-commits] twilson: branch twilson/config_work r361906 - /team/twilson/config_work/inclu...

[SVN commits to the Asterisk project]

Author: twilson
Date: Tue Apr 10 22:52:04 2012
New Revision: 361906

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=361906
Log:
A little more documentation

Modified:
    team/twilson/config_work/include/asterisk/config_options.h

Modified: team/twilson/config_work/include/asterisk/config_options.h
URL: http://svnview.digium.com/svn/asterisk/team/twilson/config_work/include/asterisk/config_options.h?view=diff&rev=361906&r1=361905&r2=361906
==============================================================================
--- team/twilson/config_work/include/asterisk/config_options.h (original)
+++ team/twilson/config_work/include/asterisk/config_options.h Tue Apr 10 22:52:04 2012
@@ -33,18 +33,27 @@
 
 struct ast_config_option;
 
+/*! \brief The option types with default handlers
+ *
+ * ast_config_option_register takes an option type which is used
+ * to look up the handler for that type. Each type requires field
+ * names for specific types in the struct being configured. Each
+ * option below is commented with the field types, *in the order
+ * they must be passed* to ast_config_option_register.
+ * */
 enum ast_config_option_type {
-	OPT_ACL_T,
-	OPT_BOOL_T,
-	OPT_CODEC_T,
-	OPT_CUSTOM_T,
-	OPT_DOUBLE_T,
-	OPT_INT_T,
-	OPT_SOCKADDR_T,
-	OPT_STRINGFIELD_T,
-	OPT_UINT_T,
+	OPT_ACL_T,         /*!< fields: struct ast_ha * */
+	OPT_BOOL_T,        /*!< fields: unsigned int */
+	OPT_CODEC_T,       /*!< fields: struct ast_codec pref, struct ast_format_cap * */
+	OPT_CUSTOM_T,      /*!< fields: none */
+	OPT_DOUBLE_T,      /*!< fields: double */
+	OPT_INT_T,         /*!< fields: int */
+	OPT_SOCKADDR_T,    /*!< fields: struct ast_sockaddr */
+	OPT_STRINGFIELD_T, /*!< fields: ast_string_field */
+	OPT_UINT_T,        /*!< fields: unsigned int */
 };
 
+/*! \brief Whether a context regex is a blackist or a whitelist */
 enum ast_config_option_context_op {
 	CONTEXT_DENY,
 	CONTEXT_ALLOW,