]> Creatis software - gdcm.git/commitdiff
Doxygenation
authorjpr <jpr>
Tue, 31 Aug 2004 14:24:46 +0000 (14:24 +0000)
committerjpr <jpr>
Tue, 31 Aug 2004 14:24:46 +0000 (14:24 +0000)
16 files changed:
Example/BuildUpDicomDir.cxx
Example/makeDicomDir.cxx
Testing/CMakeLists.txt
src/gdcmBinEntry.cxx
src/gdcmDebug.cxx
src/gdcmDicomDir.cxx
src/gdcmDicomDir.h
src/gdcmDict.cxx
src/gdcmDictSet.cxx
src/gdcmDocEntry.cxx
src/gdcmDocEntry.h
src/gdcmDocEntrySet.cxx
src/gdcmDocument.cxx
src/gdcmDocument.h
src/gdcmElementSet.cxx
src/gdcmSeqEntry.cxx

index 175bf13bc70654bba970cc8c29991fbbc6c87270..5259293bdde4a3ba3597967b2cfcc6a193e3e1fc 100644 (file)
@@ -51,12 +51,7 @@ int main(int argc, char* argv[])
       }
 
    gdcmDicomDir *dcmdir;
-   
-
-   printf( "BuildUpDicomDir: entering  BuildUpDicomDir\n");
-
    dcmdir=new gdcmDicomDir();
-   printf( "BuildUpDicomDir: exiting new DicomDir\n");
 
    printf( "\n------- BuildUpDicomDir: Test Print Meta only -----\n");
    ((gdcmDocument *)dcmdir)->Print();
@@ -92,7 +87,7 @@ int main(int argc, char* argv[])
    dcmdir->SetPrintLevel(-1);
    dcmdir->Print();
 
-   dcmdir->Write( dirName );
+   dcmdir->WriteDicomDir( dirName );
    std::cout << std::endl;
 
    delete dcmdir;
index e4b1b5ac15e6c3af91863b56f6480c6d60f0927a..a1feba5ca5dd4c3a069d284d91198cfc7ffb3efe 100644 (file)
@@ -73,7 +73,7 @@ int main(int argc, char* argv[]) {
       return 1;
    }
     
-   dcmdir->Write("NewDICOMDIR");
+   dcmdir->WriteDicomDir("NewDICOMDIR");
    std::cout<<std::flush;
 
    delete dcmdir;
index 89a40dc117ff163e39c65764fb29c590a4dbdac3..15eb490655fb60bdaa540b2e888941d98203e36b 100644 (file)
@@ -22,8 +22,8 @@ IF (GDCM_DATA_ROOT)
     PrintDicomDir.cxx
     TestChangeHeader.cxx
     TestDicomDir.cxx                 # require DICOMDIR
-   # BuildUpDicomDir.cxx
-   # makeDicomDir.cxx
+    BuildUpDicomDir.cxx              # writes a file named "NewDICOMDIR"
+    makeDicomDir.cxx                 # writes a file named "NewDICOMDIR"
   )
   # add test that require VTK:
   IF(GDCM_VTK)
index ef4f9652a9e15d54fb81badc6467b3c5849065e8..651ed623062dadb91f4126bb1734ae9f463fbd7d 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmBinEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/16 16:30:32 $
-  Version:   $Revision: 1.22 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.23 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -93,7 +93,9 @@ void gdcmBinEntry::Print(std::ostream &os)
 
 /*
  * \brief   canonical Writer
- */
+ * @param fp already open file pointer
+ * @param filetype type of the file to be written
+*/
 void gdcmBinEntry::Write(FILE *fp, FileType filetype)
 {
    gdcmDocEntry::Write(fp, filetype);
index fcd16cffdab1aa753c3a43e3184dcd79dd109c9e..2891b21cb6e358abdcc151f868420c160404a39a 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDebug.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/01 02:39:09 $
-  Version:   $Revision: 1.4 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.5 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -43,9 +43,9 @@ void gdcmDebug::SetDebug(int level)
 
 /**
  * \brief   Verbose 
- * @param Level level
- * @param Msg1 first message part
- * @param Msg2 second message part 
+ * @param level level
+ * @param msg1 first message part
+ * @param msg2 second message part 
  */
 void gdcmDebug::Verbose(int level, const char * msg1, const char * msg2) 
 {
@@ -58,9 +58,9 @@ void gdcmDebug::Verbose(int level, const char * msg1, const char * msg2)
 
 /**
  * \brief   Error 
- * @param Test test
- * @param Msg1 first message part
- * @param Msg2 second message part 
+ * @param test test
+ * @param msg1 first message part
+ * @param msg2 second message part 
  */
 void gdcmDebug::Error(bool test, const char * msg1, const char * msg2) 
 {
@@ -74,9 +74,9 @@ void gdcmDebug::Error(bool test, const char * msg1, const char * msg2)
 
 /**
  * \brief   Error 
- * @param Msg1 first message part
- * @param Msg2 second message part
- * @param Msg3 Third message part  
+ * @param msg1 first message part
+ * @param msg2 second message part
+ * @param msg3 Third message part  
  */
 void gdcmDebug::Error(const char* msg1, const char* msg2,
                       const char* msg3) 
@@ -87,10 +87,10 @@ void gdcmDebug::Error(const char* msg1, const char* msg2,
 
 /**
  * \brief   Assert 
- * @param Level level 
- * @param Test test
- * @param Msg1 first message part
- * @param Msg2 second message part
+ * @param level level 
+ * @param test test
+ * @param msg1 first message part
+ * @param msg2 second message part
  */
 void gdcmDebug::Assert(int level, bool test, const char * msg1, 
                        const char * msg2) 
index d686459ee3eaf025a1ca9d3f30201b0a0d7f9781..6b758ed193b858919c233c5d0c1cb7dc73f80c93 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/30 16:15:40 $
-  Version:   $Revision: 1.66 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.67 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -60,7 +60,7 @@ gdcmDicomDir::gdcmDicomDir()
 /**
  * \brief Constructor Parses recursively the directory and creates the DicomDir
  *        or uses an already built DICOMDIR, depending on 'parseDir' value.
- * @param FileName        name 
+ * @param fileName        name 
  *                      - of the root directory (parseDir = true)
  *                      - of the DICOMDIR       (parseDir = false)
  * @param parseDir boolean
@@ -72,12 +72,11 @@ gdcmDicomDir::gdcmDicomDir()
 gdcmDicomDir::gdcmDicomDir(std::string const & fileName, bool parseDir ):
    gdcmDocument( fileName )
 {
-   // que l'on ai passe un root directory ou un DICOMDIR
-   // et quelle que soit la valeur de parseDir,
-   // on a deja lance gdcmDocument 
+   // Whatever user passed (a root directory or a DICOMDIR)
+   // and whatever the value of parseDir was,
+   // gdcmDocument is already executed
    Initialize();  // sets all private fields to NULL
 
-   // gdcmDocument already executed
    // if user passed a root directory, sure we didn't get anything
 
    if ( TagHT.begin() == TagHT.end() ) // when user passed a Directory to parse
@@ -337,7 +336,7 @@ void gdcmDicomDir::SetEndMethodArgDelete(gdcmMethod *method)
  * @return false only when fail to open
  */
  
-bool gdcmDicomDir::Write(std::string const & fileName) 
+bool gdcmDicomDir::WriteDicomDir(std::string const & fileName) 
 {  
    uint16_t sq[4] = { 0x0004, 0x1220, 0xffff, 0xffff };
    uint16_t sqt[4]= { 0xfffe, 0xe0dd, 0xffff, 0xffff };
@@ -354,8 +353,6 @@ bool gdcmDicomDir::Write(std::string const & fileName)
    fwrite(filePreamble,128,1,fp);
    fwrite("DICM",4,1,fp);
    delete[] filePreamble;
-   
- //  UpdateDirectoryRecordSequenceLength(); // TODO (if *really* usefull)
  
    gdcmDicomDirMeta *ptrMeta = GetDicomDirMeta();
    ptrMeta->Write(fp, gdcmExplicitVR);
@@ -431,8 +428,8 @@ void gdcmDicomDir::CreateDicomDirChainedList(std::string const & path)
    }
    // sorts Patient/Study/Serie/
    std::sort(list.begin(), list.end(), gdcmDicomDir::HeaderLessThan );
-   std::string tmp = fileList.GetDirName();
-      
+   
+   std::string tmp = fileList.GetDirName();      
    //for each Header of the chained list, add/update the Patient/Study/Serie/Image info
    SetElements(tmp, list);
    CallEndMethod();
@@ -451,7 +448,7 @@ gdcmDicomDirMeta * gdcmDicomDir::NewMeta()
    { 
       TagDocEntryHT::iterator lastOneButSequence = TagHT.end();
       lastOneButSequence --;
-      // This works because ALL the 'out of Sequence' Tags belong to Meta Elems
+      // ALL the 'out of Sequence' Tags belong to Meta Elems
       // (we skip 0004|1220 [Directory record sequence] )
       for ( TagDocEntryHT::iterator cc  = TagHT.begin(); 
                                     cc != lastOneButSequence;
@@ -470,7 +467,6 @@ gdcmDicomDirMeta * gdcmDicomDir::NewMeta()
    return m;  
 }
 
-
 /**
  * \brief   adds a new Patient (with the basic elements) to a partially created DICOMDIR
  */
@@ -908,8 +904,6 @@ void gdcmDicomDir::SetElements(std::string &path, VectDocument &list)
    std::string studCurInstanceUID, studCurID;
    std::string serCurInstanceUID,  serCurID;
 
-   //SetElement( path, GDCM_DICOMDIR_META,NULL); // already done (NewMeta) 
-
    for( VectDocument::iterator it = list.begin();
                               it != list.end(); ++it )
    {
@@ -956,41 +950,7 @@ void gdcmDicomDir::SetElements(std::string &path, VectDocument &list)
  */
 bool gdcmDicomDir::HeaderLessThan(gdcmDocument *header1, gdcmDocument *header2)
 {
-
-std::cout <<header1->GetFileName() << " " << header2->GetFileName() <<std::endl;
    return *header1 < *header2;
 }
 
-/**
- * \brief   Sets the accurate value for the (0x0004,0x1220) element of a DICOMDIR
- */
-void gdcmDicomDir::UpdateDirectoryRecordSequenceLength()
-{
-
-/// \todo FIXME : to go on compiling
-///
-/// to be re written !
-///   int offset = 0;
-///   ListTag::iterator it;
-///   uint16_t gr, el;
-///   std::string vr;
-///   for(it=listEntries.begin();it!=listEntries.end();++it) {
-///      gr = (*it)->GetGroup();
-///      el = (*it)->GetElement();
-///      vr = (*it)->GetVR();      
-///      if (gr !=0xfffe) {
-///         if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") ) {    
-///            offset +=  4; // explicit VR AND OB, OW, SQ : 4 more bytes
-///         }         
-///         offset += 2 + 2 + 4 + (*it)->GetLength(); 
-///      } else {
-///         offset +=  4; // delimiters don't have a value.     
-///      }            
-///   }   
-///   //bool res=SetEntryLengthByNumber(offset, 0x0004, 0x1220); // Hope there is no dupps.
-///    SetEntryLengthByNumber(offset, 0x0004, 0x1220); // Hope there is no dupps.
-///   return;
-///
-}
-
 //-----------------------------------------------------------------------------
index 4f80a6236ec69f271a1e2af20308ea5b6e84e252..ace71379bf604deba0fa2a078672d10c5180dde4 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2004/08/26 15:29:52 $
-  Version:   $Revision: 1.27 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.28 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -85,7 +85,7 @@ public:
    gdcmDicomDirPatient* NewPatient();
 
 // Write  
-   bool Write(std::string const & fileName);
+   bool WriteDicomDir(std::string const & fileName);
 
    /// Types of the gdcmObject within the gdcmDicomDir
    typedef enum
@@ -116,8 +116,6 @@ private:
    void SetElements(std::string &path, VectDocument &list);
    void SetElement (std::string &path,gdcmDicomDirType type,
                     gdcmDocument *header);
-   
-   void UpdateDirectoryRecordSequenceLength();
 
    static bool HeaderLessThan(gdcmDocument *header1,gdcmDocument *header2);
    
index 50e775ea17835a0e26c7577adb4f7fa5e5473cb4..660d2913504ce44a75aef1fda1d4e052a3367048 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDict.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/01 02:39:09 $
-  Version:   $Revision: 1.41 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.42 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -28,7 +28,7 @@
 // Constructor / Destructor
 /**
  * \brief   Construtor
- * @param   FileName from which to build the dictionary.
+ * @param   filename from which to build the dictionary.
  */
 gdcmDict::gdcmDict(std::string const & filename)
 {
@@ -145,7 +145,7 @@ void gdcmDict::PrintByName(std::ostream& os)
 /**
  * \ingroup gdcmDict
  * \brief  adds a new Dicom Dictionary Entry 
- * @param   NewEntry entry to add 
+ * @param   newEntry entry to add 
  * @return  false if Dicom Element already exists
  */
 bool gdcmDict::AddNewEntry(gdcmDictEntry *newEntry) 
@@ -168,7 +168,7 @@ bool gdcmDict::AddNewEntry(gdcmDictEntry *newEntry)
 /**
  * \ingroup gdcmDict
  * \brief  replaces an already existing Dicom Element by a new one
- * @param   NewEntry new entry (overwrites any previous one with same tag)
+ * @param   newEntry new entry (overwrites any previous one with same tag)
  * @return  false if Dicom Element doesn't exist
  */
 bool gdcmDict::ReplaceEntry(gdcmDictEntry *newEntry)
index d6a2fb7f4ca03158e8215045337ee51c9d4e2408..ee8b8cf9f4542810698cec03828d35fd133ee7e1 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/01 02:39:09 $
-  Version:   $Revision: 1.34 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.35 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -134,9 +134,9 @@ std::map<std::string, std::list<std::string> > *
  * \ingroup gdcmDictSet
  * \brief   Loads a dictionary from a specified file, and add it
  *          to already the existing ones contained in this gdcmDictSet.
- * @param   FileName Absolute or relative filename containing the
+ * @param   fileName Absolute or relative filename containing the
  *          dictionary to load.
- * @param   Name Symbolic name that be used as identifier of the newly 
+ * @param   name Symbolic name that be used as identifier of the newly 
  *          created dictionary.
  */
 gdcmDict *gdcmDictSet::LoadDictFromFile(std::string const & fileName, 
@@ -152,7 +152,7 @@ gdcmDict *gdcmDictSet::LoadDictFromFile(std::string const & fileName,
  * \ingroup gdcmDictSet
  * \brief   Retrieve the specified dictionary (when existing) from this
  *          gdcmDictSet.
- * @param   DictName The symbolic name of the searched dictionary.
+ * @param   dictName The symbolic name of the searched dictionary.
  * \result  The retrieved dictionary.
  */
 gdcmDict *gdcmDictSet::GetDict(DictKey const & dictName) 
index e299a36b45272349d07b91d7724e3673fa064922..e2a89b1def4d7184b45fda908a4f45795b6c1198 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/01 03:20:23 $
-  Version:   $Revision: 1.15 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  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
@@ -110,6 +110,8 @@ void gdcmDocEntry::Print(std::ostream & os)
 /**
  * \ingroup gdcmDocEntry
  * \brief   Writes the common part of any gdcmValEntry, gdcmBinEntry, gdcmSeqEntry
+ * @param fp already open file pointer
+ * @param filetype type of the file to be written
  */
 void gdcmDocEntry::Write(FILE *fp, FileType filetype)
 {
index 194501ccb35b41a8fbdcba65d608dbe747d5a3d9..d41fbf510ba1d93e45beab52df98354e0e48d638 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntry.h,v $
   Language:  C++
-  Date:      $Date: 2004/08/01 03:20:23 $
-  Version:   $Revision: 1.16 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.17 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -108,7 +108,7 @@ public:
    bool IsVRUnknown() { return DictEntry->IsVRUnknown(); };
 
    /// \brief   Sets the DicEntry of the current Dicom Element
-   /// @param   NewEntry pointer to the DictEntry
+   /// @param   newEntry pointer to the DictEntry
    void SetDictEntry(gdcmDictEntry *newEntry) { DictEntry = newEntry; };
 
    /// \brief  Gets the DicEntry of the current Dicom Element
index ba497b5ff54e5333a8a5329c546dcd0f042faf90..44b15f712658fe4f1995b95f82988a4727bac2df 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/26 15:29:52 $
-  Version:   $Revision: 1.16 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.17 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -59,8 +59,8 @@ gdcmDocEntrySet::~gdcmDocEntrySet()
  * \brief   Build a new Val Entry from all the low level arguments. 
  *          Check for existence of dictionary entry, and build
  *          a default one when absent.
- * @param   Group group   number of the underlying DictEntry
- * @param   Elem  element number of the underlying DictEntry
+ * @param   group group   number of the underlying DictEntry
+ * @param   elem  element number of the underlying DictEntry
  */
 gdcmValEntry *gdcmDocEntrySet::NewValEntryByNumber(uint16_t group,
                                                    uint16_t elem) 
@@ -87,8 +87,8 @@ gdcmValEntry *gdcmDocEntrySet::NewValEntryByNumber(uint16_t group,
  * \brief   Build a new Bin Entry from all the low level arguments. 
  *          Check for existence of dictionary entry, and build
  *          a default one when absent.
- * @param   Group group   number of the underlying DictEntry
- * @param   Elem  element number of the underlying DictEntry
+ * @param   group group   number of the underlying DictEntry
+ * @param   elem  element number of the underlying DictEntry
  */
 gdcmBinEntry *gdcmDocEntrySet::NewBinEntryByNumber(uint16_t group,
                                                    uint16_t elem) 
@@ -242,7 +242,7 @@ gdcmDocEntry *gdcmDocEntrySet::NewDocEntryByName  (std::string const & name)
  * \brief   Searches both the public and the shadow dictionary (when they
  *          exist) for the presence of the DictEntry with given name.
  *          The public dictionary has precedence on the shadow one.
- * @param   Name name of the searched DictEntry
+ * @param   name Name of the searched DictEntry
  * @return  Corresponding DictEntry when it exists, NULL otherwise.
  */
 gdcmDictEntry *gdcmDocEntrySet::GetDictEntryByName(std::string const & name) 
index 37966499bb038759d5d188a47fce182a6a0f29ab..7acd21ae7b02260ec465f35d3e1dcc6f81b7928a 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/26 15:29:53 $
-  Version:   $Revision: 1.68 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.69 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -81,7 +81,7 @@ const unsigned int gdcmDocument::MAX_SIZE_PRINT_ELEMENT_VALUE = 0x7fffffff;
 
 /**
  * \brief   constructor  
- * @param   inFilename file to be opened for parsing
+ * @param   filename file to be opened for parsing
  */
 gdcmDocument::gdcmDocument( std::string const & filename ) 
               : gdcmElementSet(-1)
@@ -278,7 +278,7 @@ bool gdcmDocument::IsReadable()
 /**
  * \brief   Internal function that checks whether the Transfer Syntax given
  *          as argument is the one present in the current document.
- * @param   SyntaxToCheck The transfert syntax we need to check against.
+ * @param   syntaxToCheck The transfert syntax we need to check against.
  * @return  True when SyntaxToCheck corresponds to the Transfer Syntax of
  *          the current document. False either when the document contains
  *          no Transfer Syntax, or when the Tranfer Syntaxes doesn't match.
@@ -575,9 +575,9 @@ void gdcmDocument::Write(FILE* fp,FileType filetype)
 /**
  * \brief   Modifies the value of a given Header Entry (Dicom Element)
  *          when it exists. Create it with the given value when unexistant.
- * @param   Value (string) Value to be set
- * @param   Group   Group number of the Entry 
- * @param   Elem  Element number of the Entry
+ * @param   value (string) Value to be set
+ * @param   group   Group number of the Entry 
+ * @param   elem  Element number of the Entry
  * \return  pointer to the modified/created Header Entry (NULL when creation
  *          failed).
  */
@@ -701,9 +701,9 @@ gdcmSeqEntry * gdcmDocument::ReplaceOrCreateByNumber(
 /**
  * \brief Set a new value if the invoked element exists
  *        Seems to be useless !!!
- * @param Value new element value
- * @param Group  group number of the Entry 
- * @param Elem element number of the Entry
+ * @param value new element value
+ * @param group  group number of the Entry 
+ * @param elem element number of the Entry
  * \return  boolean 
  */
 bool gdcmDocument::ReplaceIfExistByNumber(std::string const & value, 
@@ -969,8 +969,8 @@ bool gdcmDocument::SetEntryLengthByNumber(uint32_t l,
 /**
  * \brief   Gets (from Header) the offset  of a 'non string' element value 
  *          (LoadElementValues has already be executed)
- * @param Group   group number of the Entry 
- * @param Elem  element number of the Entry
+ * @param group   group number of the Entry 
+ * @param elem  element number of the Entry
  * @return File Offset of the Element Value 
  */
 size_t gdcmDocument::GetEntryOffsetByNumber(uint16_t group, uint16_t elem) 
@@ -987,8 +987,8 @@ size_t gdcmDocument::GetEntryOffsetByNumber(uint16_t group, uint16_t elem)
 /**
  * \brief   Gets (from Header) a 'non string' element value 
  *          (LoadElementValues has already be executed)  
- * @param Group   group number of the Entry 
- * @param Elem  element number of the Entry
+ * @param group   group number of the Entry 
+ * @param elem  element number of the Entry
  * @return Pointer to the 'non string' area
  */
 void * gdcmDocument::GetEntryVoidAreaByNumber(uint16_t group, uint16_t elem) 
@@ -1005,8 +1005,8 @@ void * gdcmDocument::GetEntryVoidAreaByNumber(uint16_t group, uint16_t elem)
 /**
  * \brief         Loads (from disk) the element content 
  *                when a string is not suitable
- * @param Group   group number of the Entry 
- * @param Elem  element number of the Entry
+ * @param group   group number of the Entry 
+ * @param elem  element number of the Entry
  */
 void *gdcmDocument::LoadEntryVoidArea(uint16_t group, uint16_t elem)
 {
@@ -1038,7 +1038,7 @@ void *gdcmDocument::LoadEntryVoidArea(uint16_t group, uint16_t elem)
 /**
  * \brief         Loads (from disk) the element content 
  *                when a string is not suitable
- * @param Element  Entry whose voidArea is going to be loaded
+ * @param element  Entry whose voidArea is going to be loaded
  */
 void *gdcmDocument::LoadEntryVoidArea(gdcmBinEntry *element) 
 {
@@ -1466,7 +1466,7 @@ long gdcmDocument::ParseSQ(gdcmSeqEntry *set,
 /**
  * \brief         Loads the element content if its length doesn't exceed
  *                the value specified with gdcmDocument::SetMaxSizeLoadEntry()
- * @param         Entry Header Entry (Dicom Element) to be dealt with
+ * @param         entry Header Entry (Dicom Element) to be dealt with
  */
 void gdcmDocument::LoadDocEntry(gdcmDocEntry* entry)
 {
@@ -1632,7 +1632,7 @@ void gdcmDocument::LoadDocEntry(gdcmDocEntry* entry)
 
 /**
  * \brief  Find the value Length of the passed Header Entry
- * @param  Entry Header Entry whose length of the value shall be loaded. 
+ * @param  entry Header Entry whose length of the value shall be loaded. 
  */
 void gdcmDocument::FindDocEntryLength( gdcmDocEntry *entry )
    throw ( gdcmFormatError )
@@ -1760,7 +1760,7 @@ void gdcmDocument::FindDocEntryLength( gdcmDocEntry *entry )
 
 /**
  * \brief     Find the Value Representation of the current Dicom Element.
- * @param     Entry
+ * @param     entry
  */
 void gdcmDocument::FindDocEntryVR( gdcmDocEntry *entry )
 {
@@ -1803,7 +1803,7 @@ void gdcmDocument::FindDocEntryVR( gdcmDocEntry *entry )
  * \brief     Check the correspondance between the VR of the header entry
  *            and the taken VR. If they are different, the header entry is 
  *            updated with the new VR.
- * @param     Entry Header Entry to check
+ * @param     entry Header Entry to check
  * @param     vr    Dicom Value Representation
  * @return    false if the VR is incorrect of if the VR isn't referenced
  *            otherwise, it returns true
@@ -1886,7 +1886,7 @@ bool gdcmDocument::CheckDocEntryVR(gdcmDocEntry *entry, gdcmVRKey vr)
  * \brief   Get the transformed value of the header entry. The VR value 
  *          is used to define the transformation to operate on the value
  * \warning NOT end user intended method !
- * @param   Entry 
+ * @param   entry entry to tranform
  * @return  Transformed entry value
  */
 std::string gdcmDocument::GetDocEntryValue(gdcmDocEntry *entry)
@@ -1962,7 +1962,7 @@ std::string gdcmDocument::GetDocEntryValue(gdcmDocEntry *entry)
  *          value is used to define the reverse transformation to operate on
  *          the value
  * \warning NOT end user intended method !
- * @param   Entry 
+ * @param   entry Entry to reverse transform
  * @return  Reverse transformed entry value
  */
 std::string gdcmDocument::GetDocEntryUnvalue(gdcmDocEntry* entry)
@@ -2016,7 +2016,7 @@ std::string gdcmDocument::GetDocEntryUnvalue(gdcmDocEntry* entry)
 /**
  * \brief   Skip a given Header Entry 
  * \warning NOT end user intended method !
- * @param   entry 
+ * @param   entry entry to skip
  */
 void gdcmDocument::SkipDocEntry(gdcmDocEntry *entry) 
 {
@@ -2026,7 +2026,7 @@ void gdcmDocument::SkipDocEntry(gdcmDocEntry *entry)
 /**
  * \brief   Skips to the begining of the next Header Entry 
  * \warning NOT end user intended method !
- * @param   entry 
+ * @param   entry entry to skip
  */
 void gdcmDocument::SkipToNextDocEntry(gdcmDocEntry *entry) 
 {
@@ -2038,6 +2038,8 @@ void gdcmDocument::SkipToNextDocEntry(gdcmDocEntry *entry)
  * \brief   When the length of an element value is obviously wrong (because
  *          the parser went Jabberwocky) one can hope improving things by
  *          applying some heuristics.
+ * @param   entry entry to check
+ * @param   foundLength fist assumption about length    
  */
 void gdcmDocument::FixDocEntryFoundLength(gdcmDocEntry *entry,
                                           uint32_t foundLength)
@@ -2115,7 +2117,7 @@ void gdcmDocument::FixDocEntryFoundLength(gdcmDocEntry *entry,
 /**
  * \brief   Apply some heuristics to predict whether the considered 
  *          element value contains/represents an integer or not.
- * @param   Entry The element value on which to apply the predicate.
+ * @param   entry The element value on which to apply the predicate.
  * @return  The result of the heuristical predicate.
  */
 bool gdcmDocument::IsDocEntryAnInteger(gdcmDocEntry *entry)
@@ -2502,7 +2504,7 @@ void gdcmDocument::SwitchSwapToBigEndian()
 
 /**
  * \brief  during parsing, Header Elements too long are not loaded in memory 
- * @param NewSize
+ * @param newSize
  */
 void gdcmDocument::SetMaxSizeLoadEntry(long newSize) 
 {
@@ -2522,7 +2524,7 @@ void gdcmDocument::SetMaxSizeLoadEntry(long newSize)
 /**
  * \brief Header Elements too long will not be printed
  * \todo  See comments of \ref gdcmDocument::MAX_SIZE_PRINT_ELEMENT_VALUE 
- * @param NewSize
+ * @param newSize
  */
 void gdcmDocument::SetMaxSizePrintEntry(long newSize) 
 {
@@ -2607,16 +2609,16 @@ uint32_t gdcmDocument::GenerateFreeTagKeyInGroup(uint16_t group)
 }
 
 /**
- * \brief   Assuming the internal file pointer \ref gdcmDocument::f
+ * \brief   Assuming the internal file pointer \ref gdcmDocument::F
  *          is placed at the beginning of a tag check whether this
  *          tag is (TestGroup, TestElement).
- * \warning On success the internal file pointer \ref gdcmDocument::fp
+ * \warning On success the internal file pointer \ref gdcmDocument::Fp
  *          is modified to point after the tag.
  *          On failure (i.e. when the tag wasn't the expected tag
  *          (TestGroup, TestElement) the internal file pointer
- *          \ref gdcmDocument::fp is restored to it's original position.
- * @param   TestGroup   The expected group of the tag.
- * @param   TestElement The expected Element of the tag.
+ *          \ref gdcmDocument::Fp is restored to it's original position.
+ * @param   testGroup   The expected group of the tag.
+ * @param   testElement The expected Element of the tag.
  * @return  True on success, false otherwise.
  */
 bool gdcmDocument::ReadTag(uint16_t testGroup, uint16_t testElement)
@@ -2647,16 +2649,16 @@ bool gdcmDocument::ReadTag(uint16_t testGroup, uint16_t testElement)
 }
 
 /**
- * \brief   Assuming the internal file pointer \ref gdcmDocument::f
+ * \brief   Assuming the internal file pointer \ref gdcmDocument::F
  *          is placed at the beginning of a tag (TestGroup, TestElement),
  *          read the length associated to the Tag.
- * \warning On success the internal file pointer \ref gdcmDocument::fp
+ * \warning On success the internal file pointer \ref gdcmDocument::Fp
  *          is modified to point after the tag and it's length.
  *          On failure (i.e. when the tag wasn't the expected tag
  *          (TestGroup, TestElement) the internal file pointer
- *          \ref gdcmDocument::fp is restored to it's original position.
- * @param   TestGroup   The expected group of the tag.
- * @param   TestElement The expected Element of the tag.
+ *          \ref gdcmDocument::Fp is restored to it's original position.
+ * @param   testGroup   The expected group of the tag.
+ * @param   testElement The expected Element of the tag.
  * @return  On success returns the length associated to the tag. On failure
  *          returns 0.
  */
@@ -2806,7 +2808,7 @@ bool gdcmDocument::operator<(gdcmDocument &document)
    {
       return true;
    }
-   else if(s1 > s2)
+   else if( s1 > s2 )
    {
       return false;
    }
@@ -2821,7 +2823,7 @@ bool gdcmDocument::operator<(gdcmDocument &document)
       }
       else if ( s1 > s2 )
       {
-         return true;
+         return false;
       }
       else
       {
@@ -2840,7 +2842,7 @@ bool gdcmDocument::operator<(gdcmDocument &document)
          {
             // Serie Instance UID
             s1 = GetEntryByNumber(0x0020,0x000e);
-            s2 = document.GetEntryByNumber(0x0020,0x000e);
+            s2 = document.GetEntryByNumber(0x0020,0x000e);    
             if ( s1 < s2 )
             {
                return true;
index d43a644e27442d85efca94ba544219a8f26c194c..448d9803b86fdbf613874dd9472c68e2bb66a76e 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2004/08/26 15:29:53 $
-  Version:   $Revision: 1.31 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.32 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -238,7 +238,7 @@ private:
 
 public:
 // Accessors:
-   /// Accessor to \ref printLevel
+   /// Accessor to \ref PrintLevel
    void SetPrintLevel(int level) { PrintLevel = level; }
 
    /// Accessor to \ref Filename
@@ -247,7 +247,7 @@ public:
    /// Accessor to \ref Filename
    void SetFileName(std::string const & fileName) { Filename = fileName; }
 
-   /// 'Swap code' accessor (see \ref sw )
+   /// 'Swap code' accessor (see \ref SwapCode )
    int GetSwapCode() { return SwapCode; }
    
    /// File pointer
index 0f332f77b49c7ecc984fc84fefbae66a1342fc96..ec3f2b436f923ce91373b76363e0e4cd92f1b74a 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/07/19 03:34:12 $
-  Version:   $Revision: 1.16 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.17 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -103,7 +103,7 @@ void gdcmElementSet::Write(FILE *fp, FileType filetype)
 
 /**
  * \brief   add a new Dicom Element pointer to the H Table
- * @param   NewEntry entry to add
+ * @param   newEntry entry to add
  */
 bool gdcmElementSet::AddEntry( gdcmDocEntry *newEntry)
 {
@@ -124,7 +124,7 @@ bool gdcmElementSet::AddEntry( gdcmDocEntry *newEntry)
 
 /**
  * \brief   Clear the hash table from given entry.
- * @param   EntryToRemove Entry to remove.
+ * @param   entryToRemove Entry to remove.
  */
 bool gdcmElementSet::RemoveEntry( gdcmDocEntry *entryToRemove)
 {
index bdf20228ecc6257a8b90d0e2d8b26f50d993376a..ca6e13055ef178074d8f2930b5f2ca2f5fdeac88 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSeqEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/28 02:28:06 $
-  Version:   $Revision: 1.25 $
+  Date:      $Date: 2004/08/31 14:24:47 $
+  Version:   $Revision: 1.26 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -43,7 +43,8 @@ gdcmSeqEntry::gdcmSeqEntry(gdcmDictEntry* e, int depth)
 /**
  * \brief   Constructor from a given gdcmSeqEntry
  * @param   e Pointer to existing Doc entry
- */
+ * @param   depth depth level of the current Seq entry
+  */
 gdcmSeqEntry::gdcmSeqEntry(gdcmDocEntry* e, int depth) : gdcmDocEntry(e->GetDictEntry())
 {
    this->UsableLength = 0;