[asterisk-commits] eliel: branch eliel/data_retrieval r183693 - /team/eliel/data_retrieval/inclu...

[SVN commits to the Asterisk project]

Author: eliel
Date: Mon Mar 23 09:59:14 2009
New Revision: 183693

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=183693
Log:
More doxygen documentation...

Modified:
    team/eliel/data_retrieval/include/asterisk/data.h

Modified: team/eliel/data_retrieval/include/asterisk/data.h
URL: http://svn.digium.com/svn-view/asterisk/team/eliel/data_retrieval/include/asterisk/data.h?view=diff&rev=183693&r1=183692&r2=183693
==============================================================================
--- team/eliel/data_retrieval/include/asterisk/data.h (original)
+++ team/eliel/data_retrieval/include/asterisk/data.h Mon Mar 23 09:59:14 2009
@@ -36,8 +36,9 @@
 
 /*!
  * \brief Register a data provider.
- * \param path
- * \param handler
+ * \param path The path of the node to register.
+ * \param handler The function used to generate the content of the
+ *                node being registered.
  * \retval < 0 on error.
  * \retval 0 on success.
  */
@@ -45,7 +46,7 @@
 
 /*!
  * \brief Unregister a data provider.
- * \param path
+ * \param path Which node to unregister.
  * \retval < 0 on error.
  * \retval 0 on success.
  */
@@ -63,30 +64,31 @@
 /*!
  * \brief Release the ast_data structure.
  * \param data Which data handler to release.
+ * \see ast_data_get
  */
 void ast_data_free(struct ast_data *data);
 
 /*!
- * \brief
- * \param handler
- * \param path
- * \returns
+ * \brief Get an unsigned integer from a node.
+ * \param handler The ast_data handler.
+ * \param path Which node's content to get.
+ * \returns The requested unsigned integer value.
  */
 unsigned int ast_data_get_uint(struct ast_data *handler, const char *path);
 
 /*!
- * \brief
- * \param handler
- * \param path
- * \returns
+ * \brief Get a string from a node.
+ * \param handler The ast_data handler.
+ * \param path Which node's content to get.
+ * \returns The requested string pointer.
  */
 char *ast_data_get_str(struct ast_data *handler, const char *path);
 
 /*!
- * \brief
- * \param handler
- * \param path
- * \returns
+ * \brief Get a boolean from a node.
+ * \param handler The ast_data handler.
+ * \param path Which node's conetent to get.
+ * \returns The requested boolean.
  */
 unsigned char ast_data_get_bool(struct ast_data *handler, const char *path);