diff options
author | Benny Prijono <bennylp@teluu.com> | 2008-01-25 16:06:33 +0000 |
---|---|---|
committer | Benny Prijono <bennylp@teluu.com> | 2008-01-25 16:06:33 +0000 |
commit | d583515e9daac73925c0cb1f617aa124666e5b34 (patch) | |
tree | c3c741cc68ecba2e1f414dee164d3c8e9a4e1a03 /pjlib/include/pj/errno.h | |
parent | 1357c18f2e4cb7f2d9bddf1afb3603991b5ca08b (diff) |
Fixed doxygen comments everywhere
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@1748 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjlib/include/pj/errno.h')
-rw-r--r-- | pjlib/include/pj/errno.h | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/pjlib/include/pj/errno.h b/pjlib/include/pj/errno.h index b838f069..57d90afe 100644 --- a/pjlib/include/pj/errno.h +++ b/pjlib/include/pj/errno.h @@ -111,7 +111,18 @@ PJ_DECL(void) pj_set_netos_error(pj_status_t code); PJ_DECL(pj_str_t) pj_strerror( pj_status_t statcode, char *buf, pj_size_t bufsize); -typedef pj_str_t (*pjsip_error_callback)(pj_status_t, char*, pj_size_t); +/** + * Type of callback to be specified in #pj_register_strerror() + * + * @param e The error code to lookup. + * @param msg Buffer to store the error message. + * @param max Length of the buffer. + * + * @return The error string. + */ +typedef pj_str_t (*pj_error_callback)(pj_status_t e, char *msg, pj_size_t max); + + /** * Register strerror message handler for the specified error space. * Application can register its own handler to supply the error message @@ -133,7 +144,7 @@ typedef pj_str_t (*pjsip_error_callback)(pj_status_t, char*, pj_size_t); */ PJ_DECL(pj_status_t) pj_register_strerror(pj_status_t start_code, pj_status_t err_space, - pjsip_error_callback f); + pj_error_callback f); /** * @hideinitializer |