[asterisk-commits] tilghman: branch 1.4 r302663 - /branches/1.4/include/asterisk/astdb.h

[SVN commits to the Asterisk project]

Author: tilghman
Date: Wed Jan 19 15:20:28 2011
New Revision: 302663

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=302663
Log:
Add some API documentation

Modified:
    branches/1.4/include/asterisk/astdb.h

Modified: branches/1.4/include/asterisk/astdb.h
URL: http://svnview.digium.com/svn/asterisk/branches/1.4/include/asterisk/astdb.h?view=diff&rev=302663&r1=302662&r2=302663
==============================================================================
--- branches/1.4/include/asterisk/astdb.h (original)
+++ branches/1.4/include/asterisk/astdb.h Wed Jan 19 15:20:28 2011
@@ -33,16 +33,37 @@
 	char data[0];
 };
 
+/*!\brief Get key value specified by family/key */
 int ast_db_get(const char *family, const char *key, char *out, int outlen);
 
+/*!\brief Store value addressed by family/key*/
 int ast_db_put(const char *family, const char *key, char *value);
 
+/*!\brief Delete entry in astdb */
 int ast_db_del(const char *family, const char *key);
 
+/*!\brief Delete one or more entries in astdb
+ * If both parameters are NULL, the entire database will be purged.  If
+ * only keytree is NULL, all entries within the family will be purged.
+ * It is an error for keytree to have a value when family is NULL.
+ *
+ * \retval 0 Entries were deleted
+ * \retval -1 An error occurred
+ */
 int ast_db_deltree(const char *family, const char *keytree);
 
+/*!\brief Get a list of values within the astdb tree
+ * If family is specified, only those keys will be returned.  If keytree
+ * is specified, subkeys are expected to exist (separated from the key with
+ * a slash).  If subkeys do not exist and keytree is specified, the tree will
+ * consist of either a single entry or NULL will be returned.
+ *
+ * Resulting tree should be freed by passing the return value to ast_db_freetree()
+ * when usage is concluded.
+ */
 struct ast_db_entry *ast_db_gettree(const char *family, const char *keytree);
 
+/*!\brief Free structure created by ast_db_gettree() */
 void ast_db_freetree(struct ast_db_entry *entry);
 
 #if defined(__cplusplus) || defined(c_plusplus)