[trunk] add documentation
authorMickael Savinaud <savmickael@users.noreply.github.com>
Mon, 29 Oct 2012 22:12:02 +0000 (22:12 +0000)
committerMickael Savinaud <savmickael@users.noreply.github.com>
Mon, 29 Oct 2012 22:12:02 +0000 (22:12 +0000)
src/lib/openjp2/openjpeg.h

index d560e3043090cf6e0a3591e843a398d606e935da..6bca2e038692dbb93f780c68bfd08e9623acecca 100644 (file)
@@ -490,15 +490,28 @@ typedef void * opj_codec_t;
 /** The stream was opened for writing. */
 #define OPJ_STREAM_WRITE OPJ_FALSE
 
-
-
-
 /*
+ * Callback function prototype for read function
  * FIXME DOC
  */
 typedef OPJ_SIZE_T (* opj_stream_read_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
+
+/*
+ * Callback function prototype for write function
+ * FIXME DOC
+ */
 typedef OPJ_SIZE_T (* opj_stream_write_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
+
+/*
+ * Callback function prototype for skip function
+ * FIXME DOC
+ */
 typedef OPJ_OFF_T (* opj_stream_skip_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
+
+/*
+ * Callback function prototype for seek function
+ * FIXME DOC
+ */
 typedef opj_bool (* opj_stream_seek_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
 
 /*