Fixed doxygen data inside source code (from winfried)

1 files changed, 19 insertions, 5 deletions

diff --git a/libopenjpeg/jp2.h b/libopenjpeg/jp2.h
index e9ce242a..3cfaef4a 100644
--- a/libopenjpeg/jp2.h
+++ b/libopenjpeg/jp2.h
@@ -46,33 +46,43 @@
 #define JP2_COLR 0x636f6c72		/**< Colour specification box */
 #define JP2_JP2C 0x6a703263		/**< Contiguous codestream box */
 #define JP2_URL  0x75726c20		/**< URL box */
-#define JP2_DBTL 0x6474626c		/**< ??? */
+#define JP2_DTBL 0x6474626c		/**< Data Reference box */
 #define JP2_BPCC 0x62706363		/**< Bits per component box */
 #define JP2_JP2  0x6a703220		/**< File type fields */
-#define JP2_PCLR 0x70636c72
-#define JP2_CMAP 0x636d6170
-#define JP2_CDEF 0x63646566
+#define JP2_PCLR 0x70636c72		/**< Palette box */
+#define JP2_CMAP 0x636d6170		/**< Component Mapping box */
+#define JP2_CDEF 0x63646566		/**< Channel Definition box */
 
 /* ----------------------------------------------------------------------- */
-/* cdef, cmap, pclr, colr
+/** 
+Channel description: channel index, type, assocation
 */
 typedef struct opj_jp2_cdef_info
 {
     unsigned short cn, typ, asoc;
 } opj_jp2_cdef_info_t;
 
+/** 
+Channel descriptions and number of descriptions
+*/
 typedef struct opj_jp2_cdef
 {
     opj_jp2_cdef_info_t *info;
     unsigned short n;
 } opj_jp2_cdef_t;
 
+/** 
+Component mappings: channel index, mapping type, palette index
+*/
 typedef struct opj_jp2_cmap_comp
 {
     unsigned short cmp;
     unsigned char mtyp, pcol;
 } opj_jp2_cmap_comp_t;
 
+/** 
+Palette data: table entries, palette columns
+*/
 typedef struct opj_jp2_pclr
 {
     unsigned int *entries;
@@ -82,6 +92,9 @@ typedef struct opj_jp2_pclr
     unsigned short nr_entries, nr_channels;
 } opj_jp2_pclr_t;
 
+/** 
+Collector for ICC profile, palette, component mapping, channel description 
+*/
 struct extension
 {
     unsigned char *jp2_profile_buf;
@@ -151,6 +164,7 @@ void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
 Read the JP2H box - JP2 Header box (used in MJ2)
 @param jp2 JP2 handle
 @param cio Input buffer stream
+@param ext Collector for profile, cdef and pclr data
 @return Returns true if successful, returns false otherwise
 */
 bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio, struct extension *ext);