diff options
author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2005-10-24 20:12:06 +0000 |
---|---|---|
committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2005-10-24 20:12:06 +0000 |
commit | 2c3b3edc86c6999c3053c131972a3e29e7621bac (patch) | |
tree | b3ba750361c8145e6c629b37179fb9f1750094b4 /include/asterisk/cdr.h | |
parent | 009102fa0d7a8f95ef396d510a9a731f6f9f6f1e (diff) |
Doxygen documentation update from oej (issue #5505)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@6847 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/cdr.h')
-rwxr-xr-x | include/asterisk/cdr.h | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/include/asterisk/cdr.h b/include/asterisk/cdr.h index 6cb75e415..78df4b9de 100755 --- a/include/asterisk/cdr.h +++ b/include/asterisk/cdr.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Call Detail Record API +/*! \file + * \brief Call Detail Record API */ #ifndef _ASTERISK_CDR_H @@ -104,26 +104,23 @@ extern int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr); typedef int (*ast_cdrbe)(struct ast_cdr *cdr); -/*! Allocate a record */ -/*! +/*! \brief Allocate a CDR record * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure) */ extern struct ast_cdr *ast_cdr_alloc(void); -/*! Duplicate a record */ -/*! +/*! \brief Duplicate a record * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure) */ extern struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr); -/*! Free a record */ -/* \param cdr ast_cdr structure to free +/*! \brief Free a CDR record + * \param cdr ast_cdr structure to free * Returns nothing important */ extern void ast_cdr_free(struct ast_cdr *cdr); -/*! Initialize based on a channel */ -/*! +/*! \brief Initialize based on a channel * \param cdr Call Detail Record to use for channel * \param chan Channel to bind CDR with * Initializes a CDR and associates it with a particular channel |