[trunk] add documentation to the message handler functions

This commit is contained in:
Mickael Savinaud 2012-10-24 11:17:48 +00:00
parent 216791c3fb
commit 0d841b5e05
2 changed files with 28 additions and 4 deletions

View File

@ -150,7 +150,7 @@ typedef struct opj_codec_private
opj_codec_private_t; 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_bool OPJ_CALLCONV opj_set_info_handler( opj_codec_t * p_codec,
opj_msg_callback p_callback, opj_msg_callback p_callback,

View File

@ -1199,9 +1199,33 @@ OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (FILE * p_file,
event manager functions definitions 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); * Set the info handler use by openjpeg.
OPJ_API opj_bool OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec, opj_msg_callback p_callback,void * p_user_data); * @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);
/* /*
========================================================== ==========================================================