From: jpr <jpr>
Date: Wed, 12 Jan 2005 11:33:39 +0000 (+0000)
Subject: Enhence some comments
X-Git-Tag: Version1.0.bp~378
X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=920021ed03545a3b1925222f67fa0d72f33e7ef7;hp=6be82e2c1c1600494b0adfab5e14a584c858ea32;p=gdcm.git

Enhence some comments
---

diff --git a/src/gdcmDocument.cxx b/src/gdcmDocument.cxx
index c60284b6..75defab8 100644
--- a/src/gdcmDocument.cxx
+++ b/src/gdcmDocument.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/11 23:16:47 $
-  Version:   $Revision: 1.181 $
+  Date:      $Date: 2005/01/12 11:33:39 $
+  Version:   $Revision: 1.182 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -1015,15 +1015,13 @@ uint32_t Document::SwapLong(uint32_t a)
       case 4321 :
          a=( ((a<<24) & 0xff000000) | ((a<<8)  & 0x00ff0000) | 
              ((a>>8)  & 0x0000ff00) | ((a>>24) & 0x000000ff) );
-         break;
-   
+         break;   
       case 3412 :
          a=( ((a<<16) & 0xffff0000) | ((a>>16) & 0x0000ffff) );
-         break;
-   
+         break;  
       case 2143 :
          a=( ((a<< 8) & 0xff00ff00) | ((a>>8) & 0x00ff00ff)  );
-         break;
+      break;
       default :
          gdcmErrorMacro( "Unset swap code:" << SwapCode );
          a = 0;
@@ -2257,12 +2255,6 @@ bool Document::CheckSwap()
                Filetype = Unknown;
                return false;
          }
-         // Then the only info we have is the net2host one.
-         //if (! net2host )
-         //   SwapCode = 1234;
-         //else
-         //  SwapCode = 4321;
-         //return;
    }
 }
 
diff --git a/src/gdcmFile.cxx b/src/gdcmFile.cxx
index 11ec7fe6..5b43dc21 100644
--- a/src/gdcmFile.cxx
+++ b/src/gdcmFile.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/11 16:44:43 $
-  Version:   $Revision: 1.190 $
+  Date:      $Date: 2005/01/12 11:33:39 $
+  Version:   $Revision: 1.191 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -140,9 +140,10 @@ void File::Print(std::ostream &os)
 // Public
 /**
  * \brief   Get the size of the image data
- * 
  *          If the image can be RGB (with a lut or by default), the size 
  *          corresponds to the RGB image
+ *         (use GetImageDataRawSize if you want to be sure to get *only*
+ *          the size of the pixels)
  * @return  The image size
  */
 size_t File::GetImageDataSize()
@@ -157,9 +158,9 @@ size_t File::GetImageDataSize()
 
 /**
  * \brief   Get the size of the image data
- * 
- *          If the image can be RGB by transformation in a LUT, this
- *          transformation isn't considered
+ *          If the image could be converted to RGB using a LUT, 
+ *          this transformation is not taken into account by GetImageDataRawSize
+ *          (use GetImageDataSize if you wish)
  * @return  The raw image size
  */
 size_t File::GetImageDataRawSize()
diff --git a/src/gdcmjpeg/jdatadst.c b/src/gdcmjpeg/jdatadst.c
index 88d859d2..623f9e0d 100644
--- a/src/gdcmjpeg/jdatadst.c
+++ b/src/gdcmjpeg/jdatadst.c
@@ -22,9 +22,12 @@
 
 /* Expanded data destination object for stdio output */
 
+/**
+ * \brief very low level C 'structure', used to decode jpeg file
+ * Should not appear in the Doxygen supplied documentation
+ */
 typedef struct {
   struct jpeg_destination_mgr pub; /* public fields */
-
   FILE * outfile;    /* target stream */
   JOCTET * buffer;    /* start of buffer */
 } my_destination_mgr;
diff --git a/src/gdcmjpeg/jmemsrc.c b/src/gdcmjpeg/jmemsrc.c
index cb371bc5..b208fbc5 100644
--- a/src/gdcmjpeg/jmemsrc.c
+++ b/src/gdcmjpeg/jmemsrc.c
@@ -22,9 +22,12 @@
 
 /* Expanded data source object for memory input */
 
+/**
+ * \brief very low level C 'structure', used to decode jpeg file
+ * Should not appear in the Doxygen supplied documentation
+ */
 typedef struct {
   struct jpeg_source_mgr pub; /* public fields */
-
   JOCTET eoi_buffer[2];       /* a place to put a dummy EOI */
 } my_source_mgr;