From be171f82ec1addb31498e9744eb7b7bb90da53d1 Mon Sep 17 00:00:00 2001 From: szukw000 Date: Sun, 4 Dec 2016 23:10:44 +0100 Subject: [PATCH] Fix some doxygen information --- doc/CMakeLists.txt | 1 + doc/openjpip.dox.in | 4 ++-- src/lib/openjp2/function_list.h | 1 + src/lib/openjp2/invert.h | 2 +- src/lib/openjp2/openjpeg.h | 2 +- src/lib/openjp2/opj_malloc.h | 4 ++-- src/lib/openjp2/t1.h | 3 ++- src/lib/openjp2/t2.c | 1 + src/lib/openjp2/t2.h | 1 + src/lib/openjp2/tgt.c | 8 ++++---- src/lib/openjp2/tgt.h | 3 ++- 11 files changed, 18 insertions(+), 12 deletions(-) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index d4f3ddbe..e96c2fd1 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -6,6 +6,7 @@ find_package(Doxygen) 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_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.dox.cmake.in ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox @ONLY) diff --git a/doc/openjpip.dox.in b/doc/openjpip.dox.in index 09ed9073..2d3179c7 100644 --- a/doc/openjpip.dox.in +++ b/doc/openjpip.dox.in @@ -30,7 +30,7 @@ /*! \page openjpippage OpenJPIP v@OPENJPEG_VERSION@ Documentation * - * \section intro Introduction + * \section Introduction * 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 * ( 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_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 * 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. diff --git a/src/lib/openjp2/function_list.h b/src/lib/openjp2/function_list.h index ab091b7b..43600512 100644 --- a/src/lib/openjp2/function_list.h +++ b/src/lib/openjp2/function_list.h @@ -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_procedure the procedure to add. + * @param p_manager the user event manager. * * @return OPJ_TRUE if the procedure could be added. */ diff --git a/src/lib/openjp2/invert.h b/src/lib/openjp2/invert.h index 2fae8e54..0f4c25f7 100644 --- a/src/lib/openjp2/invert.h +++ b/src/lib/openjp2/invert.h @@ -50,7 +50,7 @@ The function in INVERT.H compute a matrix inversion with a LUP method * * @param pSrcMatrix the matrix to invert. * @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. */ OPJ_BOOL opj_matrix_inversion_f(OPJ_FLOAT32 * pSrcMatrix, diff --git a/src/lib/openjp2/openjpeg.h b/src/lib/openjp2/openjpeg.h index 7912c236..a324d92c 100644 --- a/src/lib/openjp2/openjpeg.h +++ b/src/lib/openjp2/openjpeg.h @@ -1458,7 +1458,7 @@ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec, /** * Start to compress the current image. * @param p_codec Compressor handle - * @param image Input filled image + * @param p_image Input filled image * @param p_stream Input stgream */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress ( opj_codec_t *p_codec, diff --git a/src/lib/openjp2/opj_malloc.h b/src/lib/openjp2/opj_malloc.h index 1b3fced9..6c5d45e7 100644 --- a/src/lib/openjp2/opj_malloc.h +++ b/src/lib/openjp2/opj_malloc.h @@ -56,8 +56,8 @@ void * opj_malloc(size_t size); /** Allocate a memory block with elements initialized to 0 -@param num Blocks to allocate -@param size Bytes per block to allocate +@param numOfElements Blocks 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 */ void * opj_calloc(size_t numOfElements, size_t sizeOfElements); diff --git a/src/lib/openjp2/t1.h b/src/lib/openjp2/t1.h index c3fb7bed..7eff1eff 100644 --- a/src/lib/openjp2/t1.h +++ b/src/lib/openjp2/t1.h @@ -168,7 +168,8 @@ OPJ_BOOL opj_t1_encode_cblks( opj_t1_t *t1, /** 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 tccp Tile coding parameters */ diff --git a/src/lib/openjp2/t2.c b/src/lib/openjp2/t2.c index 5a8d440c..f7519a5e 100644 --- a/src/lib/openjp2/t2.c +++ b/src/lib/openjp2/t2.c @@ -87,6 +87,7 @@ Decode a packet of a tile from a source buffer @param data_read FIXME DOC @param max_length FIXME DOC @param pack_info Packet information +@param p_manager the user event manager @return FIXME DOC */ diff --git a/src/lib/openjp2/t2.h b/src/lib/openjp2/t2.h index 3b652eea..6896a1de 100644 --- a/src/lib/openjp2/t2.h +++ b/src/lib/openjp2/t2.h @@ -99,6 +99,7 @@ Decode the packets of a tile from a source buffer @param p_data_read the source buffer @param len length of the source buffer @param cstr_info FIXME DOC +@param p_manager the user event manager @return FIXME DOC */ diff --git a/src/lib/openjp2/tgt.c b/src/lib/openjp2/tgt.c index 5e34aa91..bd3afcde 100644 --- a/src/lib/openjp2/tgt.c +++ b/src/lib/openjp2/tgt.c @@ -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 nplv[32]; 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)); 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; } @@ -81,13 +81,13 @@ opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv, opj_e /* ADD */ if (tree->numnodes == 0) { 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; } tree->nodes = (opj_tgt_node_t*) opj_calloc(tree->numnodes, sizeof(opj_tgt_node_t)); 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); return 00; } diff --git a/src/lib/openjp2/tgt.h b/src/lib/openjp2/tgt.h index 10223805..bbfb4269 100644 --- a/src/lib/openjp2/tgt.h +++ b/src/lib/openjp2/tgt.h @@ -81,9 +81,10 @@ typedef struct opj_tgt_tree Create a tag-tree @param numleafsh Width 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 */ -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.