Zilch.

[gdcm.git] / src / gdcmJpeg2000.cxx

diff --git a/src/gdcmJpeg2000.cxx b/src/gdcmJpeg2000.cxx
index 2d60fe09b816bb6973715c8e4f65dcaf78ecc098..1c9c8e499cee9bff82b7c5936fad94392654cc43 100644 (file)
--- a/src/gdcmJpeg2000.cxx
+++ b/src/gdcmJpeg2000.cxx
@@ -4,6 +4,16 @@
 #include "gdcmFile.h"
 
 //-----------------------------------------------------------------------------
+ /**
+ * \ingroup gdcmFile
+ * \brief   routine for JPEG decompression 
+ * @param fp pointer to an already open file descriptor 
+ *                      JPEG2000 encoded image
+ * @param image_buffer to receive uncompressed pixels
+ * @return 1 on success, 0 on error
+ * @warning : not yet made
+ */
+
 bool gdcmFile::gdcm_read_JPEG2000_file (FILE *fp,void * image_buffer) {
    printf("Sorry JPEG 2000 File not yet taken into account\n");
    return false;