Fix comments

diff --git a/src/gdcmBinEntry.h b/src/gdcmBinEntry.h
index 1901cdaa17cffbb9f2e07ddfc54ddf31c7c027b1..d9abd16dc58d3831045c05709912e2ca1bb9b72b 100644 (file)
--- a/src/gdcmBinEntry.h
+++ b/src/gdcmBinEntry.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmBinEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/02/02 16:18:48 $
-  Version:   $Revision: 1.36 $
+  Date:      $Date: 2005/02/17 11:03:32 $
+  Version:   $Revision: 1.37 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -30,7 +30,7 @@ namespace gdcm
  * \brief   Any Dicom Document (File or DicomDir) contains 
  *           a set of DocEntry - Dicom entries - 
  *          BinEntry is an elementary DocEntry (i.e. a ContentEntry, 
- *           as opposite to SeqEntry) whose content is non std::string
+ *           as opposed to SeqEntry) whose content is non std::string
  *          representable
  *          BinEntry is a specialisation of ContentEntry
  */
@@ -43,7 +43,7 @@ public:
 
    ~BinEntry();
    
-   void Print( std::ostream &os = std::cout, std::string const & indent = "" );
+   void Print( std::ostream &os = std::cout, std::string const &indent = "" );
 
    void WriteContent( std::ofstream *fp, FileType ft);
 

diff --git a/src/gdcmDocEntryArchive.cxx b/src/gdcmDocEntryArchive.cxx
index ee4f5bf565c99506dff8df0977fe941ca4fe0a3e..d059c6b50feefd17c482393a31b8179e7129468e 100644 (file)
--- a/src/gdcmDocEntryArchive.cxx
+++ b/src/gdcmDocEntryArchive.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntryArchive.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/02/01 10:29:55 $
-  Version:   $Revision: 1.11 $
+  Date:      $Date: 2005/02/17 11:03:32 $
+  Version:   $Revision: 1.12 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -45,11 +45,11 @@ DocEntryArchive::~DocEntryArchive()
 //-----------------------------------------------------------------------------
 // Public
 /**
- * \brief   Replace in the Header a DocEntry by the new DocEntry. The last
- *          DocEntry is kept in archive
+ * \brief   Replaces in the Header a DocEntry by the new DocEntry. 
+ *          The initial DocEntry is kept in archive.
  * @param   newEntry New entry to substitute to an other entry of the Header
- * @return  FALSE when an other DocEntry is already archived with the same
- *          generalized key, TRUE otherwise
+ * @return  FALSE when an other DocEntry is already archived 
+ *          with the same key, TRUE otherwise
  */
 bool DocEntryArchive::Push(DocEntry *newEntry)
 {
@@ -57,14 +57,14 @@ bool DocEntryArchive::Push(DocEntry *newEntry)
       return false;
 
    uint16_t group = newEntry->GetDictEntry()->GetGroup();
-   uint16_t elem = newEntry->GetDictEntry()->GetElement();
+   uint16_t elem  = newEntry->GetDictEntry()->GetElement();
    std::string key = DictEntry::TranslateToKey(group,elem);
 
    if( Archive.find(key)==Archive.end() )
    {
       // Save the old DocEntry if any
       DocEntry *old = ArchFile->GetDocEntry(group,elem);
-      Archive[key] = old;
+      Archive[key]  = old;
       if( old )
          ArchFile->RemoveEntryNoDestroy(old);
 
@@ -77,12 +77,12 @@ bool DocEntryArchive::Push(DocEntry *newEntry)
 }
 
 /**
- * \brief   Replace in the Header a DocEntry by the new DocEntry. The last
- *          DocEntry is kept in archive
- * @param   group   Group number of the Entry 
- * @param   elem  Element number of the Entry
- * @return  FALSE when an other DocEntry is already archived with the same
- *          generalized key, TRUE otherwise
+ * \brief   Removes out of the Header a DocEntry.
+ *          It's kept in archive.
+ * @param   group   Group number of the Entry to remove
+ * @param   elem  Element number of the Entry to remove
+ * @return  FALSE when an other DocEntry is already archived 
+ *          with the same key, TRUE otherwise
  */
 bool DocEntryArchive::Push(uint16_t group,uint16_t elem)
 {
@@ -102,11 +102,11 @@ bool DocEntryArchive::Push(uint16_t group,uint16_t elem)
 }
 
 /**
- * \brief   Restore in the Header the DocEntry that have the generalized key. 
- *          The old entry is destroyed.
- * @param   group   Group number of the Entry 
- * @param   elem  Element number of the Entry
- * @return  FALSE when the generalized key isn't in the archive, 
+ * \brief   Restore in the Header the DocEntry specified by (group,element). 
+ *          The archive entry is destroyed.
+ * @param   group   Group number of the Entry to restore
+ * @param   elem  Element number of the Entry to restore
+ * @return  FALSE when the key isn't in the archive, 
  *          TRUE otherwise
  */
 bool DocEntryArchive::Restore(uint16_t group,uint16_t elem)
@@ -133,8 +133,8 @@ bool DocEntryArchive::Restore(uint16_t group,uint16_t elem)
 }
 
 /**
- * \brief   Remove all DocEntry that are in the archive.  
- *          The entries aren't restored but only destroyed.
+ * \brief   Removes all DocEntry from the archive, and destroy them.  
+ *          The archives entries aren't restored.
  */
 void DocEntryArchive::ClearArchive( )
 {

diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx
index 2f0de0e39d730c292ade0fa7c22ee7fdb6c4c0ee..d1856ef67c83a871272652d625d5ba197900e09d 100644 (file)
--- a/src/gdcmDocEntrySet.cxx
+++ b/src/gdcmDocEntrySet.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/02/11 15:22:18 $
-  Version:   $Revision: 1.55 $
+  Date:      $Date: 2005/02/17 11:03:32 $
+  Version:   $Revision: 1.56 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -342,7 +342,7 @@ BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth,
 
       if ( !AddEntry(binEntry) )
       {
-         gdcmWarningMacro( "AddEntry failed allthough this is a creation.");
+         gdcmWarningMacro( "AddEntry failed although this is a creation.");
 
          delete binEntry;
          return NULL;
@@ -411,7 +411,7 @@ SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem)
 
       if( !AddEntry(seqEntry) )
       {
-         gdcmWarningMacro( "AddEntry failed allthough this is a creation.");
+         gdcmWarningMacro( "AddEntry failed although this is a creation.");
 
          delete seqEntry;
          return NULL;