From 83342f2aafcab4599b49f780e35fd249e8402b61 Mon Sep 17 00:00:00 2001
From: Even Rouault <even.rouault@spatialys.com>
Date: Sun, 30 Jul 2017 18:18:59 +0200
Subject: [PATCH] Fix Doxygen warnings (patch derived from Winfried's
 doxygen-dif.txt.zip, #849)

---
 doc/openjpip.dox.in             | 4 ++--
 src/lib/openjp2/function_list.h | 1 +
 src/lib/openjp2/invert.h        | 2 +-
 src/lib/openjp2/jp2.c           | 5 +++--
 src/lib/openjp2/openjpeg.h      | 2 +-
 src/lib/openjp2/opj_malloc.h    | 4 ++--
 src/lib/openjp2/t1.c            | 3 +++
 src/lib/openjp2/t1.h            | 7 +++++--
 src/lib/openjp2/t2.c            | 1 +
 src/lib/openjp2/t2.h            | 1 +
 src/lib/openjp2/tgt.c           | 6 +++---
 src/lib/openjp2/tgt.h           | 3 ++-
 12 files changed, 25 insertions(+), 14 deletions(-)

diff --git a/doc/openjpip.dox.in b/doc/openjpip.dox.in
index 0c84ccbb..fd06ee0e 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 e669695d..1a4046e1 100644
--- a/src/lib/openjp2/function_list.h
+++ b/src/lib/openjp2/function_list.h
@@ -91,6 +91,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 d1c560c5..f444d7fb 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/jp2.c b/src/lib/openjp2/jp2.c
index 66e058a2..6bc704e2 100644
--- a/src/lib/openjp2/jp2.c
+++ b/src/lib/openjp2/jp2.c
@@ -268,8 +268,9 @@ static OPJ_BOOL opj_jp2_write_jp(opj_jp2_t *jp2,
 
 /**
 Apply collected palette data
-@param color Collector for profile, cdef and pclr data
-@param image
+@param image Image.
+@param color Collector for profile, cdef and pclr data.
+@param p_manager the user event manager.
 @return true in case of success
 */
 static OPJ_BOOL opj_jp2_apply_pclr(opj_image_t *image,
diff --git a/src/lib/openjp2/openjpeg.h b/src/lib/openjp2/openjpeg.h
index d57947d2..0aea383b 100644
--- a/src/lib/openjp2/openjpeg.h
+++ b/src/lib/openjp2/openjpeg.h
@@ -1477,7 +1477,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 7503c28d..87c0e605 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.c b/src/lib/openjp2/t1.c
index 9ab7af30..800b6ed4 100644
--- a/src/lib/openjp2/t1.c
+++ b/src/lib/openjp2/t1.c
@@ -184,6 +184,9 @@ Decode 1 code-block
 @param orient
 @param roishift Region of interest shifting value
 @param cblksty Code-block style
+@param p_manager the event manager
+@param p_manager_mutex mutex for the event manager
+@param check_pterm whether PTERM correct termination should be checked
 */
 static OPJ_BOOL opj_t1_decode_cblk(opj_t1_t *t1,
                                    opj_tcd_cblk_dec_t* cblk,
diff --git a/src/lib/openjp2/t1.h b/src/lib/openjp2/t1.h
index 9cfdfc11..9d755b74 100644
--- a/src/lib/openjp2/t1.h
+++ b/src/lib/openjp2/t1.h
@@ -75,7 +75,7 @@ in T1.C are used by some function in TCD.C.
  *  a single 32-bit flags word to hold the state of 4 data points.  This corresponds
  *  to the 4-point-high columns that the data is processed in.
  *
- *  These #defines declare the layout of a 32-bit flags word.
+ *  These \#defines declare the layout of a 32-bit flags word.
  *
  *  This is currently done for encoding only.
  *  The values must NOT be changed, otherwise this is going to break a lot of
@@ -134,7 +134,7 @@ in T1.C are used by some function in TCD.C.
  *  word right by 3 bits and look at the same bit positions to see the
  *  values for data point 1.
  *
- *  The #defines below help a bit with this; say you have a flags word
+ *  The \#defines below help a bit with this; say you have a flags word
  *  f, you can do things like
  *
  *  (f & T1_SIGMA_THIS)
@@ -226,6 +226,9 @@ Decode the code-blocks of a tile
 @param pret Pointer to return value
 @param tilec The tile to decode
 @param tccp Tile coding parameters
+@param p_manager the event manager
+@param p_manager_mutex mutex for the event manager
+@param check_pterm whether PTERM correct termination should be checked
 */
 void opj_t1_decode_cblks(opj_thread_pool_t* tp,
                          volatile OPJ_BOOL* pret,
diff --git a/src/lib/openjp2/t2.c b/src/lib/openjp2/t2.c
index 2b546cca..93b77ef0 100644
--- a/src/lib/openjp2/t2.c
+++ b/src/lib/openjp2/t2.c
@@ -89,6 +89,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 b80891b7..63f7a21f 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 25b20235..0cbad12c 100644
--- a/src/lib/openjp2/tgt.c
+++ b/src/lib/openjp2/tgt.c
@@ -46,7 +46,7 @@
 */
 
 opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv,
-                               opj_event_mgr_t *manager)
+                               opj_event_mgr_t *p_manager)
 {
     OPJ_INT32 nplh[32];
     OPJ_INT32 nplv[32];
@@ -61,7 +61,7 @@ opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv,
 
     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;
     }
 
@@ -89,7 +89,7 @@ opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv,
     tree->nodes = (opj_tgt_node_t*) opj_calloc(tree->numnodes,
                   sizeof(opj_tgt_node_t));
     if (!tree->nodes) {
-        opj_event_msg(manager, EVT_ERROR,
+        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 0ed0e658..acc817dd 100644
--- a/src/lib/openjp2/tgt.h
+++ b/src/lib/openjp2/tgt.h
@@ -80,10 +80,11 @@ 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 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_event_mgr_t *p_manager);
 
 /**
  * Reinitialises a tag-tree from an exixting one.