Fix some doxygen information

This commit is contained in:
szukw000 2016-12-04 23:10:44 +01:00
parent 7113c4e3bb
commit be171f82ec
11 changed files with 18 additions and 12 deletions

View File

@ -6,6 +6,7 @@
find_package(Doxygen) find_package(Doxygen)
if(DOXYGEN_FOUND) if(DOXYGEN_FOUND)
EXEC_PROGRAM(${DOXYGEN} ARGS -s -u ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.dox.cmake.in)
# Configure the doxygen config file with variable from CMake and move it # Configure the doxygen config file with variable from CMake and move it
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.dox.cmake.in configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.dox.cmake.in
${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox @ONLY) ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox @ONLY)

View File

@ -30,7 +30,7 @@
/*! \page openjpippage OpenJPIP v@OPENJPEG_VERSION@ Documentation /*! \page openjpippage OpenJPIP v@OPENJPEG_VERSION@ Documentation
* *
* \section intro Introduction * \section Introduction
* This manual documents the low-level OpenJPIP C API.\n * This manual documents the low-level OpenJPIP C API.\n
* OpenJPIP software is an implementation of JPEG 2000 Part9: Interactivity tools, APIs and protocols (JPIP).\n * OpenJPIP software is an implementation of JPEG 2000 Part9: Interactivity tools, APIs and protocols (JPIP).\n
* ( For more info about JPIP, check the website: http://www.jpeg.org/jpeg2000/j2kpart9.html)\n * ( For more info about JPIP, check the website: http://www.jpeg.org/jpeg2000/j2kpart9.html)\n
@ -42,7 +42,7 @@
* - opj_jpip_transcode.c To Convert JPT/JPP-stream to JP2 or J2K * - opj_jpip_transcode.c To Convert JPT/JPP-stream to JP2 or J2K
* - opj_jpip_test.c To test index code format of a JP2 file * - opj_jpip_test.c To test index code format of a JP2 file
* *
* \section license License * \section License
* This software is released under the BSD license, anybody can use or modify the library, even for commercial applications.\n * This software is released under the BSD license, anybody can use or modify the library, even for commercial applications.\n
* The only restriction is to retain the copyright in the sources or the binaries documentation.\n * The only restriction is to retain the copyright in the sources or the binaries documentation.\n
* Neither the author, nor the university accept any responsibility for any kind of error or data loss which may occur during usage. * Neither the author, nor the university accept any responsibility for any kind of error or data loss which may occur during usage.

View File

@ -92,6 +92,7 @@ void opj_procedure_list_destroy(opj_procedure_list_t * p_list);
* *
* @param p_validation_list the list of procedure to modify. * @param p_validation_list the list of procedure to modify.
* @param p_procedure the procedure to add. * @param p_procedure the procedure to add.
* @param p_manager the user event manager.
* *
* @return OPJ_TRUE if the procedure could be added. * @return OPJ_TRUE if the procedure could be added.
*/ */

View File

@ -50,7 +50,7 @@ The function in INVERT.H compute a matrix inversion with a LUP method
* *
* @param pSrcMatrix the matrix to invert. * @param pSrcMatrix the matrix to invert.
* @param pDestMatrix data to store the inverted matrix. * @param pDestMatrix data to store the inverted matrix.
* @param n size of the matrix * @param nb_compo size of the matrix
* @return OPJ_TRUE if the inversion is successful, OPJ_FALSE if the matrix is singular. * @return OPJ_TRUE if the inversion is successful, OPJ_FALSE if the matrix is singular.
*/ */
OPJ_BOOL opj_matrix_inversion_f(OPJ_FLOAT32 * pSrcMatrix, OPJ_BOOL opj_matrix_inversion_f(OPJ_FLOAT32 * pSrcMatrix,

View File

@ -1458,7 +1458,7 @@ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec,
/** /**
* Start to compress the current image. * Start to compress the current image.
* @param p_codec Compressor handle * @param p_codec Compressor handle
* @param image Input filled image * @param p_image Input filled image
* @param p_stream Input stgream * @param p_stream Input stgream
*/ */
OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress ( opj_codec_t *p_codec, OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress ( opj_codec_t *p_codec,

View File

@ -56,8 +56,8 @@ void * opj_malloc(size_t size);
/** /**
Allocate a memory block with elements initialized to 0 Allocate a memory block with elements initialized to 0
@param num Blocks to allocate @param numOfElements Blocks to allocate
@param size Bytes per block to allocate @param sizeOfElements Bytes per block to allocate
@return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
*/ */
void * opj_calloc(size_t numOfElements, size_t sizeOfElements); void * opj_calloc(size_t numOfElements, size_t sizeOfElements);

View File

@ -168,7 +168,8 @@ OPJ_BOOL opj_t1_encode_cblks( opj_t1_t *t1,
/** /**
Decode the code-blocks of a tile Decode the code-blocks of a tile
@param t1 T1 handle @param tp Thread pool
@param pret Pointer to return value: OPJ_TRUE or OPJ_FALSE
@param tilec The tile to decode @param tilec The tile to decode
@param tccp Tile coding parameters @param tccp Tile coding parameters
*/ */

View File

@ -87,6 +87,7 @@ Decode a packet of a tile from a source buffer
@param data_read FIXME DOC @param data_read FIXME DOC
@param max_length FIXME DOC @param max_length FIXME DOC
@param pack_info Packet information @param pack_info Packet information
@param p_manager the user event manager
@return FIXME DOC @return FIXME DOC
*/ */

View File

@ -99,6 +99,7 @@ Decode the packets of a tile from a source buffer
@param p_data_read the source buffer @param p_data_read the source buffer
@param len length of the source buffer @param len length of the source buffer
@param cstr_info FIXME DOC @param cstr_info FIXME DOC
@param p_manager the user event manager
@return FIXME DOC @return FIXME DOC
*/ */

View File

@ -45,7 +45,7 @@
========================================================== ==========================================================
*/ */
opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv, opj_event_mgr_t *manager) { opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv, opj_event_mgr_t *p_manager) {
OPJ_INT32 nplh[32]; OPJ_INT32 nplh[32];
OPJ_INT32 nplv[32]; OPJ_INT32 nplv[32];
opj_tgt_node_t *node = 00; opj_tgt_node_t *node = 00;
@ -59,7 +59,7 @@ opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv, opj_e
tree = (opj_tgt_tree_t *) opj_calloc(1,sizeof(opj_tgt_tree_t)); tree = (opj_tgt_tree_t *) opj_calloc(1,sizeof(opj_tgt_tree_t));
if(!tree) { if(!tree) {
opj_event_msg(manager, EVT_ERROR, "Not enough memory to create Tag-tree\n"); opj_event_msg(p_manager, EVT_ERROR, "Not enough memory to create Tag-tree\n");
return 00; return 00;
} }
@ -81,13 +81,13 @@ opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv, opj_e
/* ADD */ /* ADD */
if (tree->numnodes == 0) { if (tree->numnodes == 0) {
opj_free(tree); opj_free(tree);
opj_event_msg(manager, EVT_WARNING, "tgt_create tree->numnodes == 0, no tree created.\n"); opj_event_msg(p_manager, EVT_WARNING, "tgt_create tree->numnodes == 0, no tree created.\n");
return 00; return 00;
} }
tree->nodes = (opj_tgt_node_t*) opj_calloc(tree->numnodes, sizeof(opj_tgt_node_t)); tree->nodes = (opj_tgt_node_t*) opj_calloc(tree->numnodes, sizeof(opj_tgt_node_t));
if(!tree->nodes) { if(!tree->nodes) {
opj_event_msg(manager, EVT_ERROR, "Not enough memory to create Tag-tree nodes\n"); opj_event_msg(p_manager, EVT_ERROR, "Not enough memory to create Tag-tree nodes\n");
opj_free(tree); opj_free(tree);
return 00; return 00;
} }

View File

@ -81,9 +81,10 @@ typedef struct opj_tgt_tree
Create a tag-tree Create a tag-tree
@param numleafsh Width of the array of leafs of the tree @param numleafsh Width of the array of leafs of the tree
@param numleafsv Height of the array of leafs of the tree @param numleafsv Height of the array of leafs of the tree
@param p_manager the user event manager
@return Returns a new tag-tree if successful, returns NULL otherwise @return Returns a new tag-tree if successful, returns NULL otherwise
*/ */
opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv, opj_event_mgr_t *manager); opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv, opj_event_mgr_t *p_manager);
/** /**
* Reinitialises a tag-tree from an exixting one. * Reinitialises a tag-tree from an exixting one.