[asterisk-commits] eliel: branch eliel/data_retrieval r183690 - /team/eliel/data_retrieval/main/

[SVN commits to the Asterisk project]

Author: eliel
Date: Mon Mar 23 08:17:57 2009
New Revision: 183690

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

Modified:
    team/eliel/data_retrieval/main/data.c

Modified: team/eliel/data_retrieval/main/data.c
URL: http://svn.digium.com/svn-view/asterisk/team/eliel/data_retrieval/main/data.c?view=diff&rev=183690&r1=183689&r2=183690
==============================================================================
--- team/eliel/data_retrieval/main/data.c (original)
+++ team/eliel/data_retrieval/main/data.c Mon Mar 23 08:17:57 2009
@@ -277,6 +277,16 @@
 	return ret ? ret : child;
 }
 
+/*!
+ * \internal
+ * \brief Generate a node with the result given a path, the generated node will be linked to
+ * the parent node when this function returns.
+ * \param parent The parent node (root_data is the main parent node)
+ * \param path Which is the node do you want?
+ * \retval NULL on error.
+ * \retval A node with the generated xml result.
+ * \see root_data
+ */
 static struct ast_xml_node *data_xml_node_retrieve(struct ao2_container *parent, const char *path)
 {
 	char *rpath, *node_name;
@@ -313,6 +323,14 @@
 	return node;
 }
 
+/*!
+ * \internal
+ * \brief Generate an xml document based on the registered callbacks and the
+ * given path.
+ * \param path What to get.
+ * \retval NULL on error.
+ * \retval An xml document with the generated result.
+ */
 static struct ast_xml_doc *data_xml_retrieve(const char *path)
 {
 	struct ast_xml_doc *doc;