diff options
| author | Mickael Savinaud <savmickael@users.noreply.github.com> | 2012-10-24 11:17:48 +0000 |
|---|---|---|
| committer | Mickael Savinaud <savmickael@users.noreply.github.com> | 2012-10-24 11:17:48 +0000 |
| commit | 0d841b5e0534004405285ee49e498db3f1fb4efc (patch) | |
| tree | 22b6bb70b287179dc73506aaa1c4cfcb78cc40fd | |
| parent | 216791c3fb2858bc32159d70e917b4abae47e000 (diff) | |
[trunk] add documentation to the message handler functions
| -rw-r--r-- | src/lib/openjp2/openjpeg.c | 2 | ||||
| -rw-r--r-- | src/lib/openjp2/openjpeg.h | 30 |
2 files changed, 28 insertions, 4 deletions
diff --git a/src/lib/openjp2/openjpeg.c b/src/lib/openjp2/openjpeg.c index 8952a25b..211f0eee 100644 --- a/src/lib/openjp2/openjpeg.c +++ b/src/lib/openjp2/openjpeg.c @@ -150,7 +150,7 @@ typedef struct opj_codec_private opj_codec_private_t; /* ---------------------------------------------------------------------- */ -/* Functions to set info_handler */ +/* Functions to set the message handlers */ opj_bool OPJ_CALLCONV opj_set_info_handler( opj_codec_t * p_codec, opj_msg_callback p_callback, diff --git a/src/lib/openjp2/openjpeg.h b/src/lib/openjp2/openjpeg.h index f1062733..c9788204 100644 --- a/src/lib/openjp2/openjpeg.h +++ b/src/lib/openjp2/openjpeg.h @@ -1199,9 +1199,33 @@ OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (FILE * p_file, event manager functions definitions ========================================================== */ -OPJ_API opj_bool OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec, opj_msg_callback p_callback,void * p_user_data); -OPJ_API opj_bool OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec, opj_msg_callback p_callback,void * p_user_data); -OPJ_API opj_bool OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec, opj_msg_callback p_callback,void * p_user_data); +/** + * Set the info handler use by openjpeg. + * @param p_codec the codec previously initialise + * @param p_callback the callback function which will be used + * @param p_user_data FIXME DOC +*/ +OPJ_API opj_bool OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec, + opj_msg_callback p_callback, + void * p_user_data); +/** + * Set the warning handler use by openjpeg. + * @param p_codec the codec previously initialise + * @param p_callback the callback function which will be used + * @param p_user_data FIXME DOC +*/ +OPJ_API opj_bool OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec, + opj_msg_callback p_callback, + void * p_user_data); +/** + * Set the error handler use by openjpeg. + * @param p_codec the codec previously initialise + * @param p_callback the callback function which will be used + * @param p_user_data FIXME DOC +*/ +OPJ_API opj_bool OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec, + opj_msg_callback p_callback, + void * p_user_data); /* ========================================================== |