]> Creatis software - gdcm.git/commitdiff
Doxygenation
authorjpr <jpr>
Mon, 10 Jan 2005 17:17:52 +0000 (17:17 +0000)
committerjpr <jpr>
Mon, 10 Jan 2005 17:17:52 +0000 (17:17 +0000)
src/gdcmDebug.cxx
src/gdcmDictEntry.cxx
src/gdcmDocument.cxx

index ee7216641d0ae583c9742a2a6f49da76c793c88f..f5ffc7df456271af0a18a9bf08fadc5dea305f87 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDebug.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/07 19:20:38 $
-  Version:   $Revision: 1.15 $
+  Date:      $Date: 2005/01/10 17:17:52 $
+  Version:   $Revision: 1.16 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -27,7 +27,7 @@ static int DebugFlag = 0;
 //-----------------------------------------------------------------------------
 /**
  * \brief   Accessor
- * @param   level Set the debug level
+ * @param   flag Set the debug flag
  */ 
 void Debug::SetDebugFlag (int flag) 
 {
@@ -36,7 +36,7 @@ void Debug::SetDebugFlag (int flag)
 
 /**
  * \brief   Accessor
- * @param   level Get the debug level
+ * @param   level Get the debug flag
  */ 
 int Debug::GetDebugFlag ()
 {
index b74c9fdb5db21639ef0e1384038a69202f6e1d46..886dd48912aa37898cb6854c3471e91d4ffe4d53 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/07 22:06:47 $
-  Version:   $Revision: 1.37 $
+  Date:      $Date: 2005/01/10 17:17:52 $
+  Version:   $Revision: 1.38 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -86,7 +86,7 @@ void DictEntry::SetVR(TagName const &vr)
 /**
  * \brief       If-and only if-the V(alue) M(ultiplicity)
  * \            is unset then overwrite it.
- * @param vr    New V(alue) M(ultiplicity) to be set.
+ * @param vm    New V(alue) M(ultiplicity) to be set.
  */
 void DictEntry::SetVM(TagName const &vm) 
 {
index ad2d33a9c0a900f31425064fd773d92078d1dfd0..d89207dd94097aea20b18bc77ec6e7a595b783cf 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/10 17:09:49 $
-  Version:   $Revision: 1.170 $
+  Date:      $Date: 2005/01/10 17:17:52 $
+  Version:   $Revision: 1.171 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -1906,14 +1906,12 @@ void Document::SkipDocEntry(DocEntry *entry)
 /**
  * \brief   Skips to the begining of the next Header Entry 
  * \warning NOT end user intended method !
- * @param   offset start of skipping
- * @param   readLgth length to skip
-
+ * @param   currentDocEntry entry to skip
  */
-void Document::SkipToNextDocEntry(DocEntry *newDocEntry) 
+void Document::SkipToNextDocEntry(DocEntry *currentDocEntry) 
 {
-   Fp->seekg((long)(newDocEntry->GetOffset()),     std::ios::beg);
-   Fp->seekg( (long)(newDocEntry->GetReadLength()),std::ios::cur);
+   Fp->seekg((long)(currentDocEntry->GetOffset()),     std::ios::beg);
+   Fp->seekg( (long)(currentDocEntry->GetReadLength()),std::ios::cur);
 }
 
 /**
@@ -1921,7 +1919,7 @@ void Document::SkipToNextDocEntry(DocEntry *newDocEntry)
  *          the parser went Jabberwocky) one can hope improving things by
  *          applying some heuristics.
  * @param   entry entry to check
- * @param   foundLength fist assumption about length    
+ * @param   foundLength first assumption about length    
  */
 void Document::FixDocEntryFoundLength(DocEntry *entry,
                                       uint32_t foundLength)