[svn-commits] eliel: branch eliel/data_retrieval r188553 - in /team/eliel/data_retrieval: i...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Wed Apr 15 10:45:04 CDT 2009
Author: eliel
Date: Wed Apr 15 10:45:00 2009
New Revision: 188553
URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=188553
Log:
Set the [in] doxygen attribute to the parameters when needed.
Modified:
team/eliel/data_retrieval/include/asterisk/data.h
team/eliel/data_retrieval/main/data.c
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=188553&r1=188552&r2=188553
==============================================================================
--- team/eliel/data_retrieval/include/asterisk/data.h (original)
+++ team/eliel/data_retrieval/include/asterisk/data.h Wed Apr 15 10:45:00 2009
@@ -45,8 +45,8 @@
/*!
* \brief Register a data provider.
- * \param path The path of the node to register.
- * \param handler The function used to generate the content of the
+ * \param[in] path The path of the node to register.
+ * \param[in] handler The function used to generate the content of the
* node being registered.
* \see ast_data_unregister
* \retval < 0 on error.
@@ -56,7 +56,7 @@
/*!
* \brief Unregister a data provider.
- * \param path Which node to unregister.
+ * \param[in] path Which node to unregister.
* \see ast_data_register
* \retval < 0 on error.
* \retval 0 on success.
@@ -65,7 +65,7 @@
/*!
* \brief Retrieve data from the specified path.
- * \param path What data to get.
+ * \param[in] path What data to get.
* \retval NULL if no data was found on the specified node.
* \retval A dynamically allocated structure with the data you asked for.
* \see ast_data_free
@@ -74,8 +74,8 @@
/*!
* \brief Get the node content type.
- * \param handler The returned ast_data handler.
- * \param path The path to the node.
+ * \param[in] handler The returned ast_data handler.
+ * \param[in] path The path to the node.
* \see ast_data_get
* \returns The type of the node pointed by 'path'.
*/
@@ -83,15 +83,15 @@
/*!
* \brief Release the ast_data structure.
- * \param data Which data handler to release.
+ * \param[in] data Which data handler to release.
* \see ast_data_get
*/
void ast_data_free(struct ast_data *data);
/*!
* \brief Get a long from a node.
- * \param handler The ast_data handler.
- * \param path Which node's content to get.
+ * \param[in] handler The ast_data handler.
+ * \param[in] path Which node's content to get.
* \see ast_data_get
* \returns The requested long integer value.
*/
@@ -99,8 +99,8 @@
/*!
* \brief Get a string from a node.
- * \param handler The ast_data handler.
- * \param path Which node's content to get.
+ * \param[in] handler The ast_data handler.
+ * \param[in] path Which node's content to get.
* \see ast_data_get
* \returns The requested string pointer.
*/
@@ -108,8 +108,8 @@
/*!
* \brief Get a boolean from a node.
- * \param handler The ast_data handler.
- * \param path Which node's conetent to get.
+ * \param[in] handler The ast_data handler.
+ * \param[in] path Which node's conetent to get.
* \see ast_data_get
* \returns The requested boolean.
*/
@@ -117,7 +117,7 @@
/*!
* \brief Create a data handler.
- * \param name The root node name.
+ * \param[in] name The root node name.
* \retval NULL on error.
* \retval The allocated ast_data_node structure.
*/
@@ -125,9 +125,9 @@
/*!
* \brief Insert a node named 'path' with the string value 'value'.
- * \param handler The result handler.
- * \param path The path of the node to insert.
- * \param value The content of the node to create.
+ * \param[in] handler The result handler.
+ * \param[in] path The path of the node to insert.
+ * \param[in] value The content of the node to create.
* \see ast_data_result
* \retval 0 on success.
* \retval -1 on error.
@@ -137,9 +137,9 @@
/*!
* \brief Insert a node named 'path' with the long integer value 'value'.
- * \param handler The result handler.
- * \param path The path of the node to insert.
- * \param value The content of the node to create.
+ * \param[in] handler The result handler.
+ * \param[in] path The path of the node to insert.
+ * \param[in] value The content of the node to create.
* \see ast_data_result
* \retval 0 on success.
* \retval -1 on error.
@@ -149,9 +149,9 @@
/*!
* \brief Insert a node named 'path' with the boolean value 'value'.
- * \param handler The result handler.
- * \param path The path of the node to insert.
- * \param value The content of the node to create.
+ * \param[in] handler The result handler.
+ * \param[in] path The path of the node to insert.
+ * \param[in] value The content of the node to create.
* \see ast_data_result
* \retval 0 on success.
* \retval -1 on error.
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=188553&r1=188552&r2=188553
==============================================================================
--- team/eliel/data_retrieval/main/data.c (original)
+++ team/eliel/data_retrieval/main/data.c Wed Apr 15 10:45:00 2009
@@ -116,7 +116,7 @@
* \internal
* \brief Get the next node name in a path (/node1/node2)
* Avoid null nodes like //node1//node2/node3.
- * \param path The path where we are going to search for the next node name.
+ * \param[in] path The path where we are going to search for the next node name.
* \retval The next node name we found inside the given path.
* \retval NULL if there are no more node names.
*/
@@ -134,7 +134,7 @@
/*!
* \internal
* \brief Create a data node new
- * \param name The node name.
+ * \param[in] name The node name.
* \retval NULL on error.
* \retval The allocated data node structure.
*/
@@ -169,8 +169,8 @@
/*!
* \internal
* \brief Add a child node named 'name' to the 'parent' node.
- * \param parent Where to add the child node.
- * \param name The name of the child node.
+ * \param[in] parent Where to add the child node.
+ * \param[in] name The name of the child node.
* \retval NULL on error.
* \retval A newly allocated child in parent.
*/
@@ -192,8 +192,8 @@
/*!
* \internal
* \brief Find a child node, based on his name.
- * \param parent Where to find the node.
- * \param name The node name to find.
+ * \param[in] parent Where to find the node.
+ * \param[in] name The node name to find.
* \retval NULL if a node wasn't found.
* \retval The node found.
* \note Remember to decrement the ref count of the returned node after using it.
@@ -217,7 +217,8 @@
/*!
* \internal
* \brief Release a group of nodes.
- * \param path The path of nodes to release.
+ * \param[in] parent The parent node.
+ * \param[in] path The path of nodes to release.
* \retval < 0 on error.
* \retval 0 on success.
* \see data_nodes_create
@@ -261,8 +262,10 @@
/*!
* \internal
* \brief Create the middle nodes for the specified path (asterisk/testnode1/childnode)
- * \param parent Where to add the middle nodes structure.
- * \param path The path of nodes to add.
+ * \param[in] parent Where to add the middle nodes structure.
+ * \param[in] path The path of nodes to add.
+ * \retval NULL on error.
+ * \retval The created node.
* \see data_nodes_release
*/
static struct data_node *data_nodes_create(struct ao2_container *parent, const char *path)
@@ -301,8 +304,8 @@
* \internal
* \brief Generate a node with the result, 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 parent_node_name The parents node name.
+ * \param[in] parent The parent node (root_data is the main parent node)
+ * \param[in] parent_node_name The parents node name.
* \retval NULL on error.
* \retval A node with the generated xml result.
* \see root_data
@@ -352,7 +355,7 @@
* \internal
* \brief Generate an xml document based on the registered callbacks and the
* given path.
- * \param path What to get.
+ * \param[in] path What to get.
* \retval NULL on error.
* \retval An xml document with the generated result.
*/
@@ -409,8 +412,8 @@
/*!
* \internal
* \brief Create xml nodes based on the path.
- * \param doc The xml document.
- * \param path The path of nodes to create.
+ * \param[in] doc The xml document.
+ * \param[in] path The path of nodes to create.
* \retval NULL on error.
* \retval A pointer to the last allocated node.
*/
@@ -466,8 +469,8 @@
/*!
* \internal
* \brief Get the node structure passing a path to it.
- * \param handler The ast_data handler.
- * \param path The path of the node.
+ * \param[in] handler The ast_data handler.
+ * \param[in] path The path of the node.
* \retval NULL if the node wasn't found.
* \retval The xml node referenced by path.
*/
More information about the svn-commits
mailing list