]> Creatis software - gdcm.git/commitdiff
Add warning about Load Mode
authorjpr <jpr>
Thu, 2 Jun 2005 13:42:18 +0000 (13:42 +0000)
committerjpr <jpr>
Thu, 2 Jun 2005 13:42:18 +0000 (13:42 +0000)
src/gdcmDocument.h

index b5e44ad7adc6338f928e5c3e0e8688d6ba752ed1..00a74ffc4bc499b58a17520f9ee8c563d3010f49 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2005/05/03 09:43:04 $
-  Version:   $Revision: 1.110 $
+  Date:      $Date: 2005/06/02 13:42:18 $
+  Version:   $Revision: 1.111 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -98,8 +98,14 @@ typedef std::list<Element> ListElements;
 // Ordering of Documents
    bool operator<(Document &document);
 
-   /// \brief Sets the LoadMode as a boolean string
-   /// NO_SEQ, NO_SHADOW, ... (nothing more, right now)
+/**
+ * \brief \brief Sets the LoadMode as a boolean string. 
+ *        NO_SEQ, NO_SHADOW, ... (nothing more, right now)
+ *        WARNING : before using NO_SHADOW, be sure *all* your files
+ *        contain accurate values in the 0x0000 element 
+ *        of each Shadow Group. The paser will fail if the size is wrong !
+ * @param   mode Load mode to be used    
+ */
    void SetLoadMode (int mode) { LoadMode = mode; }
 
 protected: