summaryrefslogtreecommitdiff
path: root/include/asterisk/datastore.h
diff options
context:
space:
mode:
authorJeff Peeler <jpeeler@digium.com>2009-03-09 20:58:17 +0000
committerJeff Peeler <jpeeler@digium.com>2009-03-09 20:58:17 +0000
commitbf0bb7b3859b7d24628c58f2ece35c89362094c1 (patch)
tree5205beb525fe5b6e38f83e5efe910d8a7bf1cfdc /include/asterisk/datastore.h
parentdea550a29252aa6ef4f67f323d90eb29c3e8c794 (diff)
Add Doxygen documentation for API changes from 1.6.0 to 1.6.1
Copied from my review board description: This is a continuation of the API changes documentation started for describing changes between releases. Most of the API changes were pretty simple needing only to be brought to attention via the new "Asterisk API Changes" list. However, if you see anything that needs further explanation feel free to supplement what is there. The current method of documenting is to add (in the header file): \version <ver number> <description of changes> and then to add the function to the change list in doxyref.h on the AstAPIChanges page. I also made sure all the functions that were newly added were tagged with \since 1.6.1. I think this is a good habit to start both for the historical aspect as well as for the future ability to easily add a "New Asterisk API" page. Review: http://reviewboard.digium.com/r/190/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@180719 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/datastore.h')
-rw-r--r--include/asterisk/datastore.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/include/asterisk/datastore.h b/include/asterisk/datastore.h
index 6eb4cf2a5..6da1bd0bb 100644
--- a/include/asterisk/datastore.h
+++ b/include/asterisk/datastore.h
@@ -59,13 +59,18 @@ struct ast_datastore {
AST_LIST_ENTRY(ast_datastore) entry; /*!< Used for easy linking */
};
-/*!
+/*!
* \brief Create a data store object
+ * \param[in] info information describing the data store object
+ * \param[in] uid unique identifer
+ * \version 1.6.1 moved here and renamed from ast_channel_datastore_alloc
*/
struct ast_datastore *ast_datastore_alloc(const struct ast_datastore_info *info, const char *uid);
/*!
* \brief Free a data store object
+ * \param[in] datastore datastore to free
+ * \version 1.6.1 moved here and renamed from ast_channel_datastore_free
*/
int ast_datastore_free(struct ast_datastore *datastore);