[asterisk-commits] rmudgett: trunk r403192 - /trunk/include/asterisk/astdb.h

[SVN commits to the Asterisk project]

Author: rmudgett
Date: Wed Nov 27 11:32:29 2013
New Revision: 403192

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=403192
Log:
astdb: Tweak some doxygen comments.

Modified:
    trunk/include/asterisk/astdb.h

Modified: trunk/include/asterisk/astdb.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/astdb.h?view=diff&rev=403192&r1=403191&r2=403192
==============================================================================
--- trunk/include/asterisk/astdb.h (original)
+++ trunk/include/asterisk/astdb.h Wed Nov 27 11:32:29 2013
@@ -16,7 +16,8 @@
  * at the top of the source tree.
  */
 
-/*! \file
+/*!
+ * \file
  * \brief Persistant data storage (akin to *doze registry)
  */
 
@@ -33,11 +34,13 @@
 	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 Get key value specified by family/key */
+int ast_db_get(const char *family, const char *key, char *value, int valuelen);
 
-/*!\brief Get key value specified by family/key as a heap allocated string.
+/*!
+ * \brief Get key value specified by family/key as a heap allocated string.
  *
+ * \details
  * Given a \a family and \a key, sets \a out to a pointer to a heap
  * allocated string.  In the event of an error, \a out will be set to
  * NULL.  The string must be freed by calling ast_free().
@@ -47,13 +50,16 @@
  */
 int ast_db_get_allocated(const char *family, const char *key, char **out);
 
-/*!\brief Store value addressed by family/key */
+/*! \brief Store value addressed by family/key */
 int ast_db_put(const char *family, const char *key, const char *value);
 
-/*!\brief Delete entry in astdb */
+/*! \brief Delete entry in astdb */
 int ast_db_del(const char *family, const char *key);
 
-/*!\brief Delete one or more entries in astdb
+/*!
+ * \brief Delete one or more entries in astdb
+ *
+ * \details
  * 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.
@@ -63,7 +69,10 @@
  */
 int ast_db_deltree(const char *family, const char *keytree);
 
-/*!\brief Get a list of values within the astdb tree
+/*!
+ * \brief Get a list of values within the astdb tree
+ *
+ * \details
  * 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
@@ -74,7 +83,7 @@
  */
 struct ast_db_entry *ast_db_gettree(const char *family, const char *keytree);
 
-/*!\brief Free structure created by ast_db_gettree() */
+/*! \brief Free structure created by ast_db_gettree() */
 void ast_db_freetree(struct ast_db_entry *entry);
 
 #if defined(__cplusplus) || defined(c_plusplus)