More explanations, for Doxygen (and developpers)

[gdcm.git] / src / gdcmFileHelper.h

diff --git a/src/gdcmFileHelper.h b/src/gdcmFileHelper.h
index f4322b9b0196927a2a3b2c1b351e449647f34fa1..a6a098bb2c72076fcf1e0a12d3d4bbff1f380146 100644 (file)
--- a/src/gdcmFileHelper.h
+++ b/src/gdcmFileHelper.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFileHelper.h,v $
   Language:  C++
-  Date:      $Date: 2005/11/07 09:50:52 $
-  Version:   $Revision: 1.30 $
+  Date:      $Date: 2005/11/22 20:26:06 $
+  Version:   $Revision: 1.33 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -52,11 +52,11 @@ public:
    };
      
 public:
+/// \brief Constructs a FileHelper with a RefCounter
    static FileHelper *New() {return new FileHelper();}
+/// \brief Constructs a FileHelper with a RefCounter from a fileHelper  
    static FileHelper *New(File *header) {return new FileHelper(header);}
    
-   virtual ~FileHelper();
-
    void Print(std::ostream &os = std::cout, std::string const &indent = ""); 
 
    /// Accessor to \ref File
@@ -158,6 +158,7 @@ public:
 protected:
    FileHelper( );
    FileHelper( File *header );
+   ~FileHelper();
 
    bool CheckWriteIntegrity();
 
@@ -220,8 +221,8 @@ private:
    /// See vtkgdcmSerieViewer for an example
    VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
    
-   /// if user knows he didn't modify the pixels (e.g. he just anonymized 
-   /// the file), he is allowed to ask to keep the original
+   /// \brief if user knows he didn't modify the pixels (e.g. he just 
+   /// anonymized the file), he is allowed to ask to keep the original
    /// 'Media Storage SOP Class UID' and 'Image Type'  
    bool KeepMediaStorageSOPClassUID;
 };