Doxygenation

[gdcm.git] / src / gdcmDocument.h

diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h
index b5e44ad7adc6338f928e5c3e0e8688d6ba752ed1..d164af6a55497bedd792c2c64d74901d613cbbdc 100644 (file)
--- a/src/gdcmDocument.h
+++ b/src/gdcmDocument.h
@@ -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/03 09:05:15 $
+  Version:   $Revision: 1.112 $
  
   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 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 (if any) 
+ *        of *each* Shadow Group. The parser will fail if the size is wrong !
+ * @param   mode Load mode to be used    
+ */
    void SetLoadMode (int mode) { LoadMode = mode; }
 
 protected: