kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-21 09:10:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

astdb: Tweak some doxygen comments.

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@403192 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Richard Mudgett
2013-11-27 17:32:29 +00:00
parent 9d3b590ad8
commit 48c2b40ff3
1 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
include/asterisk/astdb.h
View File

@@ -16,7 +16,8 @@
* at the top of the source tree. * at the top of the source tree.
*/ */
/*! \file /*!
* \file
* \brief Persistant data storage (akin to *doze registry) * \brief Persistant data storage (akin to *doze registry)
*/ */
@@ -33,11 +34,13 @@ struct ast_db_entry {
char data[0]; char data[0];
}; };
/*!\brief Get key value specified by family/key */ /*! \brief Get key value specified by family/key */
int ast_db_get(const char *family, const char *key, char *out, int outlen); 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 * 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 * allocated string. In the event of an error, \a out will be set to
* NULL. The string must be freed by calling ast_free(). * NULL. The string must be freed by calling ast_free().
@@ -47,13 +50,16 @@ int ast_db_get(const char *family, const char *key, char *out, int outlen);
*/ */
int ast_db_get_allocated(const char *family, const char *key, char **out); 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); 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); 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 * If both parameters are NULL, the entire database will be purged. If
* only keytree is NULL, all entries within the family will be purged. * 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. * It is an error for keytree to have a value when family is NULL.
@@ -63,7 +69,10 @@ int ast_db_del(const char *family, const char *key);
*/ */
int ast_db_deltree(const char *family, const char *keytree); 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 * If family is specified, only those keys will be returned. If keytree
* is specified, subkeys are expected to exist (separated from the key with * 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 * a slash). If subkeys do not exist and keytree is specified, the tree will
@@ -74,7 +83,7 @@ int ast_db_deltree(const char *family, const char *keytree);
*/ */
struct ast_db_entry *ast_db_gettree(const char *family, const char *keytree); 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); void ast_db_freetree(struct ast_db_entry *entry);
#if defined(__cplusplus) || defined(c_plusplus) #if defined(__cplusplus) || defined(c_plusplus)