[trunk] Fix remainings issues with doxygen doc

Convert DOS files to UNIX eol

doc/CMakeLists.txt

@@ -22,6 +22,12 @@ if(DOXYGEN_FOUND)
   configure_file(${CMAKE_CURRENT_SOURCE_DIR}/jpip_protocol.png
     ${CMAKE_BINARY_DIR}/doc/html/jpip_protocol.png COPYONLY)
 
+  file(GLOB headers
+    ${OPENJPEG_SOURCE_DIR}/src/lib/openjp2/*.h
+    ${OPENJPEG_SOURCE_DIR}/src/lib/openjp2/*.c
+    ${OPENJPEG_SOURCE_DIR}/src/lib/openjpip/*.h
+    ${OPENJPEG_SOURCE_DIR}/src/lib/openjpip/*.c
+  )
   # Generate new target to build the html documentation
   add_custom_command(
     OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/index.html
@@ -29,6 +35,7 @@ if(DOXYGEN_FOUND)
     DEPENDS ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox
             ${CMAKE_BINARY_DIR}/doc/mainpage.dox
             ${CMAKE_BINARY_DIR}/doc/openjpip.dox
+            ${headers}
   )
   add_custom_target(doc ALL
     DEPENDS ${CMAKE_BINARY_DIR}/doc/html/index.html

doc/Doxyfile.dox.cmake.in

@@ -1,4 +1,4 @@
-# Doxyfile 1.7.3
+# Doxyfile 1.7.1
 
 #---------------------------------------------------------------------------
 # Project related configuration options
@@ -6,8 +6,6 @@
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = OpenJPEG
 PROJECT_NUMBER         = @OPENJPEG_VERSION@
-PROJECT_BRIEF          =
-PROJECT_LOGO           =
 OUTPUT_DIRECTORY       = @OPENJPEG_BINARY_DIR@/doc
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
@@ -74,7 +72,6 @@ SORT_BRIEF_DOCS        = NO
 SORT_MEMBERS_CTORS_1ST = NO
 SORT_GROUP_NAMES       = NO
 SORT_BY_SCOPE_NAME     = NO
-STRICT_PROTO_MATCHING  = NO
 GENERATE_TODOLIST      = YES
 GENERATE_TESTLIST      = YES
 GENERATE_BUGLIST       = YES
@@ -100,7 +97,8 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = @OPENJPEG_SOURCE_DIR@/src/lib \
+INPUT                  = @OPENJPEG_SOURCE_DIR@/src/lib/openjp2 \
+                         @OPENJPEG_SOURCE_DIR@/src/lib/openjpip \
                          @OPENJPEG_BINARY_DIR@/doc
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h \
@@ -109,16 +107,15 @@ FILE_PATTERNS          = *.h \
 RECURSIVE              = YES
 EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
-EXCLUDE_PATTERNS       = .svn
+EXCLUDE_PATTERNS       = */.svn/*
 EXCLUDE_SYMBOLS        =
 EXAMPLE_PATH           =
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             =
+IMAGE_PATH             = @OPENJPEG_SOURCE_DIR@/doc
 INPUT_FILTER           =
 FILTER_PATTERNS        =
 FILTER_SOURCE_FILES    = NO
-FILTER_SOURCE_PATTERNS =
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
 #---------------------------------------------------------------------------
@@ -181,8 +178,6 @@ TREEVIEW_WIDTH         = 250
 EXT_LINKS_IN_WINDOW    = NO
 FORMULA_FONTSIZE       = 10
 FORMULA_TRANSPARENT    = YES
-USE_MATHJAX            = NO
-MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 SEARCHENGINE           = NO
 SERVER_BASED_SEARCH    = NO
 #---------------------------------------------------------------------------
@@ -282,7 +277,6 @@ DIRECTORY_GRAPH        = YES
 DOT_IMAGE_FORMAT       = png
 DOT_PATH               =
 DOTFILE_DIRS           =
-MSCFILE_DIRS           =
 DOT_GRAPH_MAX_NODES    = 50
 MAX_DOT_GRAPH_DEPTH    = 1000
 DOT_TRANSPARENT        = NO

src/lib/openjp2/invert.h

@@ -45,6 +45,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
  * @return OPJ_TRUE if the inversion is successful, OPJ_FALSE if the matrix is singular.
  */
 opj_bool opj_matrix_inversion_f(OPJ_FLOAT32 * pSrcMatrix,

src/lib/openjp2/mct.h

@@ -110,9 +110,9 @@ opj_bool opj_mct_encode_custom(
 FIXME DOC
 @param pDecodingData    MCT data
 @param n                size of components
-@param pDataa           components
+@param pData            components
 @param pNbComp          nb of components (i.e. size of p_data)
-@param isSigneda        tells if the data is signed
+@param isSigned         tells if the data is signed
 @return OPJ_FALSE if function encounter a problem, OPJ_TRUE otherwise
 */
 opj_bool opj_mct_decode_custom(

src/lib/openjp2/pi.c

@@ -98,6 +98,7 @@ static void opj_pi_update_encode_poc_and_final ( opj_cp_t *p_cp,
  * Updates the coding parameters if the encoding is not used with Progression order changes and final (and cinema parameters are used).
  *
  * @param	p_cp		the coding parameters to modify
+ * @param	p_num_comps		the number of components
  * @param	p_tileno	the tile index being concerned.
  * @param	p_tx0		X0 parameter for the tile
  * @param	p_tx1		X1 parameter for the tile
@@ -105,8 +106,8 @@ static void opj_pi_update_encode_poc_and_final ( opj_cp_t *p_cp,
  * @param	p_ty1		Y1 parameter for the tile
  * @param	p_max_prec	the maximum precision for all the bands of the tile
  * @param	p_max_res	the maximum number of resolutions for all the poc inside the tile.
- * @param	dx_min		the minimum dx of all the components of all the resolutions for the tile.
+ * @param	p_dx_min		the minimum dx of all the components of all the resolutions for the tile.
- * @param	dy_min		the minimum dy of all the components of all the resolutions for the tile.
+ * @param	p_dy_min		the minimum dy of all the components of all the resolutions for the tile.
  */
 static void opj_pi_update_encode_not_poc (  opj_cp_t *p_cp,
                                             OPJ_UINT32 p_num_comps,
@@ -124,15 +125,15 @@ static void opj_pi_update_encode_not_poc (  opj_cp_t *p_cp,
  * 
  * @param	p_image			the image being encoded.
  * @param	p_cp			the coding parameters.
- * @param	p_tileno			the tile index of the tile being encoded.
+ * @param	tileno			the tile index of the tile being encoded.
  * @param	p_tx0			pointer that will hold the X0 parameter for the tile
  * @param	p_tx1			pointer that will hold the X1 parameter for the tile
  * @param	p_ty0			pointer that will hold the Y0 parameter for the tile
  * @param	p_ty1			pointer that will hold the Y1 parameter for the tile
  * @param	p_max_prec		pointer that will hold the the maximum precision for all the bands of the tile
  * @param	p_max_res		pointer that will hold the the maximum number of resolutions for all the poc inside the tile.
- * @param	dx_min			pointer that will hold the the minimum dx of all the components of all the resolutions for the tile.
+ * @param	p_dx_min			pointer that will hold the the minimum dx of all the components of all the resolutions for the tile.
- * @param	dy_min			pointer that will hold the the minimum dy of all the components of all the resolutions for the tile.
+ * @param	p_dy_min			pointer that will hold the the minimum dy of all the components of all the resolutions for the tile.
  */
 static void opj_get_encoding_parameters(const opj_image_t *p_image,
                                         const opj_cp_t *p_cp,
@@ -184,10 +185,10 @@ static void opj_get_all_encoding_parameters(const opj_image_t *p_image,
  * 
  * @param	p_image		the image used to initialize the packet iterator (in fact only the number of components is relevant.
  * @param	p_cp		the coding parameters.
- * @param	p_tile_no	the index of the tile from which creating the packet iterator.
+ * @param	tileno	the index of the tile from which creating the packet iterator.
  */
-static opj_pi_iterator_t * opj_pi_create(	const opj_image_t *image,
+static opj_pi_iterator_t * opj_pi_create(	const opj_image_t *p_image,
-                                            const opj_cp_t *cp,
+                                            const opj_cp_t *p_cp,
                                             OPJ_UINT32 tileno );
 /**
  * FIXME DOC

src/lib/openjp2/pi.h

@@ -85,8 +85,8 @@ typedef struct opj_pi_iterator {
   OPJ_UINT32 precno;
   /** layer that identify the packet */
   OPJ_UINT32 layno;
-	/** 0 if the first packet TODO MSD xhange to opj_bool*/
+  /** 0 if the first packet */
-	int first; 
+  opj_bool first;
   /** progression order change information */
   opj_poc_t poc;
   /** number of components in the image */

src/lib/openjpip/dec_clientmsg_handler.h

@@ -95,6 +95,8 @@ void handle_dstCIDreqMSG( SOCKET connected_socket, cachelist_param_t *cachelist)
  * handle SIZ request message
  *
  * @param[in]     connected_socket socket descriptor
+ * @param[in] jpipstream       address of caching jpipstream pointer
+ * @param[in] msgqueue         message queue pointer
  * @param[in,out] cachelist        cache list pointer
  */
 void handle_SIZreqMSG( SOCKET connected_socket, Byte_t *jpipstream, msgqueue_param_t *msgqueue, cachelist_param_t *cachelist);

src/lib/openjpip/imgreg_manager.h

@@ -68,13 +68,13 @@ imgreg_param_t map_viewin2imgreg( const int fx,    const int fy,
  * Note: only round-down implemented
  *
  * @param[in]     maxlev maximum decomposition level
- * @param[in/out] lev    decomposition level pointer
+ * @param[in,out] lev    decomposition level pointer
- * @param[in/out] fx     horizontal frame size pointer
+ * @param[in,out] fx     horizontal frame size pointer
- * @param[in/out] fy     vertical   frame size pointer
+ * @param[in,out] fy     vertical   frame size pointer
- * @param[in/out] xmin   horizontal image offset pointer
+ * @param[in,out] xmin   horizontal image offset pointer
- * @param[in/out] ymin   vertical   image offset pointer
+ * @param[in,out] ymin   vertical   image offset pointer
- * @param[in/out] xmax   horizontal image size pointer
+ * @param[in,out] xmax   horizontal image size pointer
- * @param[in/out] ymax   vertical   image size pointer
+ * @param[in,out] ymax   vertical   image size pointer
  */
 void find_level( int maxlev, int *lev, int *fx, int *fy, int *xmin, int *ymin, int *xmax, int *ymax);
 
@@ -82,8 +82,8 @@ void find_level( int maxlev, int *lev, int *fx, int *fy, int *xmin, int *ymin, i
  * compute decomposition level (only to get the level
  *   use find_level for all parameters
  *
- * @param[in] fx   horizontal frame size
+ * @param[in] fw   horizontal frame size
- * @param[in] fy   vertical   frame size
+ * @param[in] fh   vertical   frame size
  * @param[in] Xsiz image width
  * @param[in] Ysiz image height
  * @return decomposition level

src/lib/openjpip/marker_manager.h

@@ -60,7 +60,6 @@ marker_param_t set_marker( codestream_param_t cs, Byte2_t code, OPJ_OFF_T offset
  *
  * @param[in] marker marker structure
  * @param[in] offset start Byte position in marker
- * @param[in] size   Byte length
  * @return           fetched code
  */
 Byte_t fetch_marker1byte( marker_param_t marker, OPJ_OFF_T offset);

src/lib/openjpip/metadata_manager.h

@@ -115,7 +115,7 @@ void print_metadata( metadata_param_t *metadata);
 /**
  * print all metadata parameters
  *
- * @param[in] metadatalist metadata list pointer
+ * @param[in] list metadata list pointer
  */
 void print_allmetadata( metadatalist_param_t *list);
 

src/lib/openjpip/query_parser.h

@@ -54,7 +54,7 @@ typedef struct query_param{
   bool *comps;                                /**< components (dynamic array) for jpp-stream, null means all components */
   char *cid;                                  /**< channel identifier */
   cnew_transport_t cnew;                      /**< transport name if there is new channel request, else non */
-  char *cclose;                               /**< list of closing channel identifiers, separated by '\0' */
+  char *cclose;                               /**< list of closing channel identifiers, separated by '\\0' */
   int numOfcclose;                            /**< number of closing channels */
   char box_type[MAX_NUMOFBOX][4];             /**< interested box-types */
   int limit[MAX_NUMOFBOX];                    /**< limit value, -1: skeleton request "r", 0: entire contents */