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

[SVN commits to the Asterisk project]

Author: eliel
Date: Wed Apr 15 11:48:30 2009
New Revision: 188579

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

Modified:
    team/eliel/data_retrieval/include/asterisk/data.h
    team/eliel/data_retrieval/include/asterisk/doxyref.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=188579&r1=188578&r2=188579
==============================================================================
--- team/eliel/data_retrieval/include/asterisk/data.h (original)
+++ team/eliel/data_retrieval/include/asterisk/data.h Wed Apr 15 11:48:30 2009
@@ -18,10 +18,50 @@
  * \file
  * \brief Data retrieval API.
  * \author Eliel C. Sardanons (LU1ALY) <eliels at gmail.com>
+ * \arg \ref AstDataRetrieval
  */
 
 #ifndef ASTERISK_DATA_H
 #define ASTERISK_DATA_H
+
+/*!
+ * \page AstDataRetrieval The Asterisk DATA retrieval API.
+ *
+ * This module implements an abstraction for retrieving asterisk data and
+ * export it.
+ *
+ * \note
+ *	There are four types of nodes:
+ *		LONG
+ *		STRING
+ *		BOOLEAN
+ *		CONTAINER
+ *  \endnote
+ *
+ * \section USAGE
+ *
+ * The asterisk data is organized in a hierarchical structure. The data
+ * is retrieved passing a path of the node we want to get:
+ * \code
+ * 	struct ast_data *handler;
+ *
+ * 	handler = ast_data_get("/asterisk/channels/sip/channels");
+ * \endcode
+ *
+ * The returned handler is used to get specific nodes values and
+ * iterate throw the returned nodes.
+ *
+ * To access each specific node you must use the specific getter made
+ * for the node type you are trying to retrieve.
+ *
+ * \code
+ * 	long uniqueid;
+ *
+ * 	uniqueid = ast_date_get_long(handler, "uniqueid");
+ * \endcode
+ *
+ */
+
 
 #if defined(__cplusplus) || defined(c_plusplus)
 extern "C" {

Modified: team/eliel/data_retrieval/include/asterisk/doxyref.h
URL: http://svn.digium.com/svn-view/asterisk/team/eliel/data_retrieval/include/asterisk/doxyref.h?view=diff&rev=188579&r1=188578&r2=188579
==============================================================================
--- team/eliel/data_retrieval/include/asterisk/doxyref.h (original)
+++ team/eliel/data_retrieval/include/asterisk/doxyref.h Wed Apr 15 11:48:30 2009
@@ -439,6 +439,7 @@
  * \arg \ref AstThreadStorage
  * \arg \ref DataStores
  * \arg \ref AstExtState
+ * \arg \ref AstDataRetrieval
  *
  * \subsection model_txt Generic Model
  * \verbinclude model.txt