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

[SVN commits to the Asterisk project]

Author: eliel
Date: Fri Apr  3 09:37:27 2009
New Revision: 186291

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=186291
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=186291&r1=186290&r2=186291
==============================================================================
--- team/eliel/data_retrieval/include/asterisk/data.h (original)
+++ team/eliel/data_retrieval/include/asterisk/data.h Fri Apr  3 09:37:27 2009
@@ -20,8 +20,8 @@
  * \author Eliel C. Sardanons (LU1ALY) <eliels at gmail.com>
  */
 
-#ifndef AST_DATA_H
-#define AST_DATA_H
+#ifndef ASTERISK_DATA_H
+#define ASTERISK_DATA_H
 
 #if defined(__cplusplus) || defined(c_plusplus)
 extern "C" {
@@ -48,6 +48,7 @@
  * \param path The path of the node to register.
  * \param handler The function used to generate the content of the
  *                node being registered.
+ * \see ast_data_unregister
  * \retval < 0 on error.
  * \retval 0 on success.
  */
@@ -56,6 +57,7 @@
 /*!
  * \brief Unregister a data provider.
  * \param path Which node to unregister.
+ * \see ast_data_register
  * \retval < 0 on error.
  * \retval 0 on success.
  */
@@ -75,6 +77,7 @@
  * \param handler The returned ast_data handler.
  * \param path The path to the node.
  * \see ast_data_get
+ * \returns The type of the node pointed by 'path'.
  */
 enum ast_data_type ast_data_get_type(struct ast_data *handler, const char *path);
 
@@ -89,6 +92,7 @@
  * \brief Get an unsigned integer from a node.
  * \param handler The ast_data handler.
  * \param path Which node's content to get.
+ * \see ast_data_get
  * \returns The requested unsigned integer value.
  */
 unsigned int ast_data_get_uint(struct ast_data *handler, const char *path);
@@ -97,6 +101,7 @@
  * \brief Get a string from a node.
  * \param handler The ast_data handler.
  * \param path Which node's content to get.
+ * \see ast_data_get
  * \returns The requested string pointer.
  */
 char *ast_data_get_str(struct ast_data *handler, const char *path);
@@ -105,6 +110,7 @@
  * \brief Get a boolean from a node.
  * \param handler The ast_data handler.
  * \param path Which node's conetent to get.
+ * \see ast_data_get
  * \returns The requested boolean.
  */
 unsigned char ast_data_get_bool(struct ast_data *handler, const char *path);
@@ -113,15 +119,16 @@
  * \brief Create a data handler.
  * \param name The root node name.
  * \retval NULL on error.
- * \retval The allocated ast_data structure.
+ * \retval The allocated ast_data_node structure.
  */
 struct ast_data_node *ast_data_result(const char *name);
 
 /*!
  * \brief Insert a node named 'path' with the string value 'value'.
- * \param handler
- * \param path
- * \param value
+ * \param handler The result handler.
+ * \param path The path of the node to insert.
+ * \param value The content of the node to create.
+ * \see ast_data_result
  * \retval 0 on success.
  * \retval -1 on error.
  */
@@ -129,9 +136,10 @@
 
 /*!
  * \brief Insert a node named 'path' with the unsigned integer value 'value'.
- * \param handler
- * \param path
- * \param value
+ * \param handler The result handler.
+ * \param path The path of the node to insert.
+ * \param value The content of the node to create.
+ * \see ast_data_result
  * \retval 0 on success.
  * \retval -1 on error.
  */
@@ -139,9 +147,10 @@
 
 /*!
  * \brief Insert a node named 'path' with the boolean value 'value'.
- * \param handler
- * \param path
- * \param value
+ * \param handler The result handler.
+ * \param path The path of the node to insert.
+ * \param value The content of the node to create.
+ * \see ast_data_result
  * \retval 0 on success.
  * \retval -1 on error.
  */
@@ -151,4 +160,4 @@
 }
 #endif
 
-#endif /* AST_DATA_H */
+#endif /* ASTERISK_DATA_H */