diff options
author | Jeff Peeler <jpeeler@digium.com> | 2009-03-09 20:58:17 +0000 |
---|---|---|
committer | Jeff Peeler <jpeeler@digium.com> | 2009-03-09 20:58:17 +0000 |
commit | bf0bb7b3859b7d24628c58f2ece35c89362094c1 (patch) | |
tree | 5205beb525fe5b6e38f83e5efe910d8a7bf1cfdc /include/asterisk/logger.h | |
parent | dea550a29252aa6ef4f67f323d90eb29c3e8c794 (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/logger.h')
-rw-r--r-- | include/asterisk/logger.h | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/include/asterisk/logger.h b/include/asterisk/logger.h index 06f3f5206..65448cfe4 100644 --- a/include/asterisk/logger.h +++ b/include/asterisk/logger.h @@ -43,7 +43,7 @@ extern "C" { #define VERBOSE_PREFIX_3 " -- " #define VERBOSE_PREFIX_4 " > " -/*! \brief Used for sending a log message +/*! \brief Used for sending a log message This is the standard logger function. Probably the only way you will invoke it would be something like this: ast_log(AST_LOG_WHATEVER, "Problem with the %s Captain. We should get some more. Will %d be enough?\n", "flux capacitor", 10); where WHATEVER is one of ERROR, DEBUG, EVENT, NOTICE, or WARNING depending @@ -89,9 +89,18 @@ int ast_unregister_verbose(void (*verboser)(const char *string)) attribute_warn_ void ast_console_puts(const char *string); +/*! + * \brief log the string to the console, and all attached + * console clients + * \version 1.6.1 added level parameter + */ void ast_console_puts_mutable(const char *string, int level); void ast_console_toggle_mute(int fd, int silent); -void ast_console_toggle_loglevel(int fd, int leve, int state); + +/*! + * \since 1.6.1 + */ +void ast_console_toggle_loglevel(int fd, int level, int state); /* Note: The AST_LOG_* macros below are the same as * the LOG_* macros and are intended to eventually replace @@ -229,7 +238,7 @@ unsigned int ast_verbose_get_by_file(const char *file); #define AST_MAX_BT_FRAMES 32 /* \brief * - * A structure to hold backtrace information. This structure provides an easy means to + * A structure to hold backtrace information. This structure provides an easy means to * store backtrace information or pass backtraces to other functions. */ struct ast_bt { @@ -245,6 +254,7 @@ struct ast_bt { * Allocates memory for an ast_bt and stores addresses and symbols. * * \return Returns NULL on failure, or the allocated ast_bt on success + * \since 1.6.1 */ struct ast_bt *ast_bt_create(void); @@ -253,14 +263,16 @@ struct ast_bt *ast_bt_create(void); * * \retval 0 Success * \retval -1 Failure + * \since 1.6.1 */ int ast_bt_get_addresses(struct ast_bt *bt); /* \brief - * + * * Free dynamically allocated portions of an ast_bt * * \retval NULL. + * \since 1.6.1 */ void *ast_bt_destroy(struct ast_bt *bt); |