Update for version 0.8

1 files changed, 58 insertions, 1 deletions

diff --git a/libopenjpeg/cio.h b/libopenjpeg/cio.h
index c6945b7e..c75a4653 100644
--- a/libopenjpeg/cio.h
+++ b/libopenjpeg/cio.h
@@ -27,14 +27,71 @@
 #ifndef __CIO_H
 #define __CIO_H
 
+/* 
+ * Number of bytes written.
+ *
+ * returns number of bytes written
+ */
+int cio_numbytes();
+
+/*
+ * Get position in byte stream.
+ *
+ * return position in bytes
+ */
 int cio_tell();
+
+/*
+ * Set position in byte stream.
+ *
+ * pos : position, in number of bytes, from the beginning of the stream
+ */
 void cio_seek(int pos);
-int cio_numbytes();
+
+/*
+ * Number of bytes left before the end of the stream.
+ *
+ * Returns the number of bytes before the end of the stream 
+ */
 int cio_numbytesleft();
+
+/*
+ * Get pointer to the current position in the stream.
+ *
+ * return : pointer to the position
+ */
 unsigned char *cio_getbp();
+
+/* 
+ * Initialize byte IO
+ *
+ * bp  : destination/source stream
+ * len : length of the stream
+ */
 void cio_init(unsigned char *bp, int len);
+
+/*
+ * Write some bytes.
+ *
+ * v : value to write
+ * n : number of bytes to write
+ */
 void cio_write(unsigned int v, int n);
+
+/*
+ * Read some bytes.
+ *
+ * n : number of bytes to read
+ *
+ * return : value of the n bytes read
+ */
 unsigned int cio_read(int n);
+
+/* 
+ * Skip some bytes.
+ *
+ * n : number of bytes to skip
+ */
 void cio_skip(int n);
 
 #endif