[asterisk-commits] eliel: branch group/data_api_gsoc2009 r203567 - in /team/group/data_api_gsoc2...

[SVN commits to the Asterisk project]

Author: eliel
Date: Thu Jun 25 21:36:44 2009
New Revision: 203567

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=203567
Log:
Add more documentation.


Modified:
    team/group/data_api_gsoc2009/include/asterisk/xml.h
    team/group/data_api_gsoc2009/main/data.c

Modified: team/group/data_api_gsoc2009/include/asterisk/xml.h
URL: http://svn.asterisk.org/svn-view/asterisk/team/group/data_api_gsoc2009/include/asterisk/xml.h?view=diff&rev=203567&r1=203566&r2=203567
==============================================================================
--- team/group/data_api_gsoc2009/include/asterisk/xml.h (original)
+++ team/group/data_api_gsoc2009/include/asterisk/xml.h Thu Jun 25 21:36:44 2009
@@ -45,23 +45,24 @@
  */
 struct ast_xml_doc *ast_xml_open(char *filename);
 
-/*! \brief
+/*! \brief Create a XML document.
  *  \retval NULL on error.
- *  \retval The allocated document structure.
+ *  \retval non-NULL The allocated document structure.
  */
 struct ast_xml_doc *ast_xml_new(void);
 
-/*! \brief
- *  \param name
+/*! \brief Create a XML node.
+ *  \param name The name of the node to be created.
  *  \retval NULL on error.
- *  \retval The allocated node structe.
+ *  \retval non-NULL The allocated node structe.
  */
 struct ast_xml_node *ast_xml_new_node(const char *name);
 
-/*! \brief
- * \param parent
- * \param child_name
+/*! \brief Add a child node inside a passed parent node.
+ * \param parent The pointer of the parent node.
+ * \param child_name The name of the child node to add.
  * \retval NULL on error.
+ * \retval non-NULL The created child node pointer.
  */
 struct ast_xml_node *ast_xml_new_child(struct ast_xml_node *parent, const char *child_name);
 
@@ -70,7 +71,7 @@
  * \param parent Where to add the child node.
  * \param child The child node to add.
  * \retval NULL on error.
- * \retval The add child node on success.
+ * \retval non-NULL The add child node on success.
  */
 struct ast_xml_node *ast_xml_add_child(struct ast_xml_node *parent, struct ast_xml_node *child);
 
@@ -80,10 +81,10 @@
  */
 void ast_xml_close(struct ast_xml_doc *doc);
 
-/*! \brief
- * \param doc
- * \param node
- * \retval NULL on error.
+/*!
+ * \brief Specify the root node of a XML document.
+ * \param doc The document pointer.
+ * \param node A pointer to the node we want to set as root node.
  */
 void ast_xml_set_root(struct ast_xml_doc *doc, struct ast_xml_node *node);
 

Modified: team/group/data_api_gsoc2009/main/data.c
URL: http://svn.asterisk.org/svn-view/asterisk/team/group/data_api_gsoc2009/main/data.c?view=diff&rev=203567&r1=203566&r2=203567
==============================================================================
--- team/group/data_api_gsoc2009/main/data.c (original)
+++ team/group/data_api_gsoc2009/main/data.c Thu Jun 25 21:36:44 2009
@@ -818,13 +818,11 @@
 
 /*!
  * \internal
- * \brief Allocate the memory for a data node that will be 
- *        created and allocated in response to issuing the
- *        callback
- * \param root
- * \param name
- * \param type
- * \param ptr
+ * \brief Insert a child node inside a passed parent node.
+ * \param root Where we are going to insert the child node.
+ * \param name The name of the child node to add.
+ * \param type The type of content inside the child node.
+ * \param ptr The actual content of the child node.
  * \retval NULL on error.
  * \retval non-NULL The added child node pointer.
  */
@@ -865,7 +863,7 @@
 	case AST_DATA_IPADDR:
 		node->payload.ipaddr = *(struct in_addr *)ptr;
 		break;
-
+	case AST_DATA_CONTAINER:
 	default:
 		break;
 	}