]> Creatis software - gdcm.git/commitdiff
2005-01-18 Jean-Pierre Roux <jpr@creatis.univ-lyon1.fr>
authorjpr <jpr>
Tue, 18 Jan 2005 08:01:40 +0000 (08:01 +0000)
committerjpr <jpr>
Tue, 18 Jan 2005 08:01:40 +0000 (08:01 +0000)
   remove useless and never updated keyword \ingroup

15 files changed:
src/gdcmDictSet.cxx
src/gdcmDirList.cxx
src/gdcmDocEntry.cxx
src/gdcmDocument.cxx
src/gdcmDocument.h
src/gdcmElementSet.cxx
src/gdcmElementSet.h
src/gdcmException.cxx
src/gdcmGlobal.cxx
src/gdcmJpeg.cxx
src/gdcmSQItem.cxx
src/gdcmSeqEntry.cxx
src/gdcmSerieHeader.cxx
src/gdcmTS.cxx
src/gdcmUtil.cxx

index f8bb4f35d036407c104bd480d9c91ad632ff521b..c825df10881e294f980218ac1443f29751f6dec0 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 07:50:58 $
-  Version:   $Revision: 1.52 $
+  Date:      $Date: 2005/01/18 08:01:40 $
+  Version:   $Revision: 1.53 $
                                                                                 
   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,7 @@ DictSet::DictSet()
  */
 DictSet::~DictSet() 
 {
-   // Remove dictionnaries
+   // Remove dictionaries
    for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) 
    {
       Dict *entryToDelete = tag->second;
@@ -195,10 +195,10 @@ DictEntry *DictSet::NewVirtualDictEntry( uint16_t group,
 
 /**
  * \brief   Obtain from the GDCM_DICT_PATH environnement variable the
- *          path to directory containing the dictionnaries. When
+ *          path to directory containing the dictionaries. When
  *          the environnement variable is absent the path is defaulted
  *          to "../Dicts/".
- * @return  path to directory containing the dictionnaries
+ * @return  path to directory containing the dictionaries
  */
 std::string DictSet::BuildDictPath() 
 {
index 3362843a05e2a779d8007b3e8e784d1ba994b8bc..4422a0a8434590af61cde2e9517a52ce61e25a22 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDirList.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/14 23:51:40 $
-  Version:   $Revision: 1.38 $
+  Date:      $Date: 2005/01/18 08:01:41 $
+  Version:   $Revision: 1.39 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -34,7 +34,6 @@ namespace gdcm
 {
 // Constructor / Destructor
 /**
- * \ingroup DirList
  * \brief Constructor  
  * @param  dirName root directory name
  * @param  recursive whether we want to explore recursively or not 
@@ -46,7 +45,6 @@ DirList::DirList(std::string const &dirName, bool recursive)
 }
 
 /**
- * \ingroup DirList
  * \brief  Destructor
  */
 DirList::~DirList()
@@ -57,8 +55,8 @@ DirList::~DirList()
 // Public
 
 /**
- * \ingroup DirList
  * \brief   Print method
+ * @param os ostream to write to 
  */
 void DirList::Print(std::ostream &os)
 {
@@ -119,7 +117,7 @@ int DirList::Explore(std::string const &dirpath, bool recursive)
 
    // According to POSIX, the dirent structure contains a field char d_name[]
    // of  unspecified  size,  with  at most NAME_MAX characters preceding the
-   // terminating null character.  Use of other fields will harm  the  porta-
+   // terminating null character.  Use of other fields will harm the  porta-
    // bility  of  your  programs.
 
    struct stat buf;
index 9021e931fa3b6083f38a1764cc9643ae46866c86..a1718533e6a66549090c313e922122d66a6ab997 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/16 04:50:41 $
-  Version:   $Revision: 1.41 $
+  Date:      $Date: 2005/01/18 08:01:41 $
+  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
@@ -35,7 +35,6 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup DocEntry
  * \brief   Constructor from a given DictEntry
  * @param   in Pointer to existing dictionary entry
  */
@@ -54,7 +53,6 @@ DocEntry::DocEntry(DictEntry *in)
 //-----------------------------------------------------------------------------
 // Print
 /**
- * \ingroup DocEntry
  * \brief   Prints the common part of ValEntry, BinEntry, SeqEntry
  * @param   os ostream we want to print in
  */
@@ -116,7 +114,6 @@ void DocEntry::Print(std::ostream &os, std::string const & )
 }
 
 /**
- * \ingroup DocEntry
  * \brief   Writes the common part of any ValEntry, BinEntry, SeqEntry
  * @param fp already open file pointer
  * @param filetype type of the file to be written
@@ -216,7 +213,6 @@ void DocEntry::WriteContent(std::ofstream *fp, FileType filetype)
 // Public
 
 /**
- * \ingroup DocEntry
  * \brief   Gets the full length of the elementary DocEntry (not only value
  *          length) depending on the VR.
  */
@@ -242,8 +238,8 @@ uint32_t DocEntry::GetFullLength()
 }
 
 /**
- * \ingroup DocEntry
  * \brief   Copies all the attributes from an other DocEntry 
+ * @param e entry to copy from
  */
 void DocEntry::Copy (DocEntry *e)
 {
@@ -251,11 +247,9 @@ void DocEntry::Copy (DocEntry *e)
    ReadLength = e->ReadLength;
    ImplicitVR = e->ImplicitVR;
    Offset     = e->Offset;
-   // TODO : remove DocEntry SQDepth
 }
 
 /**
- * \ingroup DocEntry
  * \brief   tells us if entry is the last one of a 'no length' SequenceItem 
  *          (fffe,e00d) 
  */
@@ -264,7 +258,6 @@ bool DocEntry::IsItemDelimitor()
    return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
 }
 /**
- * \ingroup DocEntry
  * \brief   tells us if entry is the last one of a 'no length' Sequence 
  *          (fffe,e0dd) 
  */
index ddc83e5703ea57a22dde697c861e09f129c0deab..73486bc72fbed3adddd83fb5b0690717769e7856 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/17 17:31:01 $
-  Version:   $Revision: 1.194 $
+  Date:      $Date: 2005/01/18 08:01:41 $
+  Version:   $Revision: 1.195 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -2977,10 +2977,7 @@ int Document::ComputeGroup0002Length( FileType filetype )
    bool found0002 = false;   
   
    // for each zero-level Tag in the DCM Header
-   DocEntry *entry;
-
-   InitTraversal();
-   entry = GetNextEntry();
+   DocEntry *entry = GetFirstEntry();
    while(entry)
    {
       gr = entry->GetGroup();
index a504c596c88b2841eccbf47ef2d11dc7bbdf5dd4..8a7bce381a0ad68548395d37561c9d1bd9dff1a3 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/17 16:52:21 $
-  Version:   $Revision: 1.88 $
+  Date:      $Date: 2005/01/18 08:01:41 $
+  Version:   $Revision: 1.89 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -48,13 +48,11 @@ public:
    FileType GetFileType();
 
    std::string GetTransferSyntax();
-
-   bool IsDicomV3();
-
    RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
    JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
 
-// Dictionnaries
+// Dictionaries
    virtual void PrintPubDict (std::ostream &os = std::cout);
    virtual void PrintShaDict (std::ostream &os = std::cout);
 
@@ -127,6 +125,8 @@ public:
    /// Return the Transfer Syntax as a string
    std::string GetTransferSyntaxName();
 
+   bool IsDicomV3();
+
 protected:
 // Methods
    // Constructor and destructor are protected to forbid end user 
index afabc9af283024ab1be792978e7aca7055c828ee..769c7814034f358ddfe93f54b0c6950b44179b9d 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/16 04:50:41 $
-  Version:   $Revision: 1.42 $
+  Date:      $Date: 2005/01/18 08:01:41 $
+  Version:   $Revision: 1.43 $
                                                                                 
   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,6 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup ElementSet
  * \brief   Constructor from a given ElementSet
  */
 //BOZ depthLevel is not usefull anymore
@@ -39,7 +38,6 @@ ElementSet::ElementSet(int depthLevel)
 }
 
 /**
- * \ingroup ElementSet
  * \brief   Canonical destructor.
  */
 ElementSet::~ElementSet() 
@@ -59,6 +57,7 @@ ElementSet::~ElementSet()
 /**
   * \brief   Prints the Header Entries (Dicom Elements)
   *          from the H Table
+  * @param os ostream to write to  
   * @return
   */ 
 void ElementSet::Print(std::ostream &os, std::string const & )
@@ -70,9 +69,9 @@ void ElementSet::Print(std::ostream &os, std::string const & )
       entry->SetPrintLevel(PrintLevel);
       entry->Print(os);   
 
-      if ( SeqEntry *seqEntry = dynamic_cast<SeqEntry*>(entry) )
+      if ( /*SeqEntry *seqEntry = */dynamic_cast<SeqEntry*>(entry) )
       {
-         (void)seqEntry;
+         //(void)seqEntry;
          // Avoid the newline for a sequence:
          continue;
       }
@@ -85,6 +84,7 @@ void ElementSet::Print(std::ostream &os, std::string const & )
 /**
   * \brief   Writes the Header Entries (Dicom Elements)
   *          from the H Table
+  * @param os ostream to write to  
   * @return
   */ 
 void ElementSet::WriteContent(std::ofstream *fp, FileType filetype)
@@ -126,8 +126,6 @@ bool ElementSet::AddEntry(DocEntry *newEntry)
 /**
  * \brief   Clear the hash table from given entry AND delete the entry.
  * @param   entryToRemove Entry to remove AND delete.
- * \warning Some problems when using under Windows... prefer the use of
- *          Initialize / GetNext methods
  */
 bool ElementSet::RemoveEntry( DocEntry *entryToRemove)
 {
@@ -135,7 +133,7 @@ bool ElementSet::RemoveEntry( DocEntry *entryToRemove)
    if( TagHT.count(key) == 1 )
    {
       TagHT.erase(key);
-      gdcmVerboseMacro( "One element erased.");
+      //gdcmVerboseMacro( "One element erased.");
       delete entryToRemove;
       return true;
    }
@@ -154,7 +152,7 @@ bool ElementSet::RemoveEntryNoDestroy(DocEntry *entryToRemove)
    if( TagHT.count(key) == 1 )
    {
       TagHT.erase(key);
-      gdcmVerboseMacro( "One element erased.");
+      //gdcmVerboseMacro( "One element erased.");
       return true;
    }
 
@@ -163,15 +161,18 @@ bool ElementSet::RemoveEntryNoDestroy(DocEntry *entryToRemove)
 }
 
 /**
- * \brief   Initialise the visit of the Hash table (TagHT)
+ * \brief   Get the first entry while visiting the DocEntrySet
+ * \return  The first DocEntry if found, otherwhise NULL
  */
-void ElementSet::InitTraversal()
+DocEntry *ElementSet::GetFirstEntry()
 {
    ItTagHT = TagHT.begin();
+   return ItTagHT->second;
 }
 
 /**
- * \brief   Get the next entry whil visiting the Hash table (TagHT)
+ * \brief   Get the next entry while visiting the Hash table (TagHT)
+ * \note : meaningfull only if GetFirstEntry already called 
  * \return  The next DocEntry if found, otherwhise NULL
  */
 DocEntry *ElementSet::GetNextEntry()
index 7a4e5124430e67d41ada5c01f0c4bc8354e127f2..3bd508c7a757cfcf2dc67f362468c56164e10112 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/16 04:50:41 $
-  Version:   $Revision: 1.31 $
+  Date:      $Date: 2005/01/18 08:01:41 $
+  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
@@ -54,13 +54,8 @@ public:
    bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
    
    void WriteContent(std::ofstream *fp, FileType filetype); 
-   
-   /// Accessor to \ref TagHT
-   // Do not expose this to user (public API) ! 
-   // A test is using it thus put it in public (matt)
-   //TagDocEntryHT const &GetTagHT() const { return TagHT; };
 
-   void InitTraversal();
+   DocEntry *GetFirstEntry();
    DocEntry *GetNextEntry();
 
 protected:
index 21184b7826c56d7adaa6b462d677bfba2df830f3..471bc41e2eccb9d774e342ed58e9dc6c28f3cfbc 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmException.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.23 $
+  Date:      $Date: 2005/01/18 08:01:41 $
+  Version:   $Revision: 1.24 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -26,10 +26,9 @@ namespace gdcm
 // Exception
 
 /**
- * \ingroup Exception
  * \brief constructor
- * @param f
- * @param msg  
+ * @param f f
+ * @param msg msg 
  */
 Exception::Exception(const std::string &f, const std::string &msg) throw()
 #ifdef __GNUC__
@@ -45,9 +44,8 @@ catch(...) {
 
 
 /**
- * \ingroup Exception
  * \brief fatal
- * @param from 
+ * @param from from
  */
 void Exception::fatal(const char *from) throw() {
    try
@@ -72,7 +70,6 @@ void Exception::fatal(const char *from) throw() {
 }
 
 /**
- * \ingroup Exception
  * \brief getName
  * @return string
  */
@@ -113,7 +110,6 @@ std::string Exception::getName() const throw()
 }
 
 /**
- * \ingroup Exception
  * \brief Exception
  */
  Exception::operator const char *() const throw() {
@@ -122,8 +118,8 @@ std::string Exception::getName() const throw()
 
 //-----------------------------------------------------------------------------
 /**
- * \ingroup Exception
  * \brief Exception::operator <<
+ * @param os ostream to write to
  */
  std::ostream& operator<<(std::ostream &os, const Exception &e) {
   try {  
index 4120c2a60b996730a2a5a321e69b4d732c517e36..a3a46599e12984cf7965514d5b624e854ea5fc6a 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmGlobal.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/11 11:37:14 $
-  Version:   $Revision: 1.14 $
+  Date:      $Date: 2005/01/18 08:01:41 $
+  Version:   $Revision: 1.15 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -39,39 +39,33 @@ const std::string GDCM_NOTLOADED = "gdcm::NotLoaded";
 const std::string GDCM_UNREAD    = "gdcm::UnRead";
 
 /**
- * \ingroup Globals
  * \brief Pointer to a container, holding _all_ the Dicom Dictionaries.
  */
 DictSet         *Global::Dicts  = (DictSet *)0;
 
 /**
- * \ingroup Globals
  * \brief   Pointer to a hash table containing the 'Value Representations'.
  */
 VR              *Global::ValRes     = (VR *)0;
 
 /**
- * \ingroup Globals
  * \brief   Pointer to a hash table containing the Transfer Syntax codes
  *          and their english description 
  */
 TS              *Global::TranSyn     = (TS *)0;
 
 /**
- * \ingroup Globals
  * \brief   Pointer to the hash table containing the Dicom Elements
  *          necessary to describe each part of a DICOMDIR 
  */
 DicomDirElement *Global::ddElem = (DicomDirElement *)0;
 
 /**
- * \ingroup Globals
  * \brief   Global container
  */
 Global Glob;
 
 /**
- * \ingroup Global
  * \brief   constructor : populates the various H Tables
  */
 Global::Global()
@@ -88,7 +82,6 @@ Global::Global()
 }
 
 /**
- * \ingroup Global
  * \brief   canonical destructor 
  */
 Global::~Global()
@@ -99,7 +92,6 @@ Global::~Global()
    delete ddElem;
 }
 /**
- * \ingroup Global
  * \brief   returns a pointer to the 'Value Representation Table' 
  */
 VR *Global::GetVR()
@@ -107,7 +99,6 @@ VR *Global::GetVR()
    return ValRes;
 }
 /**
- * \ingroup Global
  * \brief   returns a pointer to the 'Transfer Syntax Table' 
  */
 TS *Global::GetTS()
@@ -115,7 +106,6 @@ TS *Global::GetTS()
    return TranSyn;
 }
 /**
- * \ingroup Global
  * \brief   returns a pointer to Dictionaries Table 
  */
 DictSet *Global::GetDicts()
@@ -123,7 +113,6 @@ DictSet *Global::GetDicts()
    return Dicts;
 }
 /**
- * \ingroup Global
  * \brief   returns a pointer to the DicomDir related elements Table 
  */
 DicomDirElement *Global::GetDicomDirElements()
index 9749edd9fba303fa5f41d81149875b08faab690c..28f58b3f7e0d9f27f0db32c690f265374d41f7e7 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmJpeg.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/12 19:02:13 $
-  Version:   $Revision: 1.31 $
+  Date:      $Date: 2005/01/18 08:01:41 $
+  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
@@ -127,7 +127,6 @@ namespace gdcm
  */
 
  /**
- * \ingroup File
  * \brief   routine for JPEG decompression 
  * @param fp pointer to an already open file descriptor 
  *                      8 significant bits per pixel
index 8f0c59ebdf2cabc1d09508d02b60b8495ee91beb..4717dcb0274a19e83af24ab424abdd93477cf543 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/17 11:07:40 $
-  Version:   $Revision: 1.52 $
+  Date:      $Date: 2005/01/18 08:01:42 $
+  Version:   $Revision: 1.53 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -32,7 +32,6 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup SQItem
  * \brief   Constructor from a given SQItem
  */
 SQItem::SQItem(int depthLevel ) 
@@ -95,7 +94,6 @@ void SQItem::Print(std::ostream &os, std::string const &)
 }
 
 /*
- * \ingroup SQItem
  * \brief   canonical Writer
  */
 void SQItem::WriteContent(std::ofstream *fp, FileType filetype)
@@ -276,7 +274,7 @@ void SQItem::Initialize()
 }
                                                                                 
 /**
- * \brief   Get the next entry whil visiting the chained list
+ * \brief   Get the next entry while visiting the chained list
  * \return  The next DocEntry if found, otherwhise NULL
  */
 DocEntry *SQItem::GetNextEntry()
index a0fc0bcf4e599f6c1ed8cc9b6239786fbdd4581e..59404d034c4399e49b041a2eab02455047a8770b 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSeqEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/17 11:13:21 $
-  Version:   $Revision: 1.44 $
+  Date:      $Date: 2005/01/18 08:01:42 $
+  Version:   $Revision: 1.45 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -33,7 +33,6 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup SeqEntry
  * \brief   Constructor from a given SeqEntry
  */
 SeqEntry::SeqEntry( DictEntry *e ) 
index e1347e2635cc42d6901426d0e24af4c6e4165f03..05f2ecef1d6be1e665e3924081ef317802459609 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSerieHeader.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/14 22:20:11 $
-  Version:   $Revision: 1.9 $
+  Date:      $Date: 2005/01/18 08:01:42 $
+  Version:   $Revision: 1.10 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -135,7 +135,6 @@ void SerieHeader::OrderGdcmFileList()
 //-----------------------------------------------------------------------------
 // Private
 /**
- * \ingroup Header
  * \brief sorts the images, according to their Patient Position
  *  We may order, considering :
  *   -# Image Number
@@ -257,7 +256,6 @@ bool SerieHeader::ImagePositionPatientOrdering()
 }
 
 /**
- * \ingroup Header
  * \brief sorts the images, according to their Image Number
  * @return false only if the header is bugged !
  */
@@ -320,7 +318,6 @@ bool SerieHeader::ImageNumberOrdering()
 
 
 /**
- * \ingroup Header
  * \brief sorts the images, according to their File Name
  * @return false only if the header is bugged !
  */
index d61ca287af2c98a8cc75b151a264f431e12bcda9..392cc548e5c97b9c9d402200cf2370e6fec0f776 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmTS.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/11 23:16:47 $
-  Version:   $Revision: 1.36 $
+  Date:      $Date: 2005/01/18 08:01:42 $
+  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
@@ -110,7 +110,6 @@ TS::~TS()
 //-----------------------------------------------------------------------------
 // Print
 /**
- * \ingroup VR
  * \brief   Print all 
  * @param   os The output stream to be written to.
  */
index f0b9def9a836880cb03391b0c1656accf8561cd5..1b7462cc7bf15ccbe8c94164afc1166e339f7f08 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmUtil.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/17 23:11:25 $
-  Version:   $Revision: 1.109 $
+  Date:      $Date: 2005/01/18 08:01:42 $
+  Version:   $Revision: 1.110 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -75,7 +75,6 @@
 namespace gdcm 
 {
 /**
- * \ingroup Globals
  * \brief Provide a better 'c++' approach for sprintf
  * For example c code is:
  * sprintf(trash, "%04x|%04x", group , elem);
@@ -105,7 +104,6 @@ std::string Util::Format(const char *format, ...)
 
 
 /**
- * \ingroup Globals
  * \brief Because not available in C++ (?)
  */
 void Util::Tokenize (const std::string &str,
@@ -123,7 +121,6 @@ void Util::Tokenize (const std::string &str,
 }
 
 /**
- * \ingroup Globals
  * \brief Because not available in C++ (?)
  *        Counts the number of occurences of a substring within a string
  */
@@ -149,7 +146,6 @@ int Util::CountSubstring (const std::string &str,
 }
 
 /**
- * \ingroup Globals
  * \brief  Weed out a string from the non-printable characters (in order
  *         to avoid corrupting the terminal of invocation when printing)
  * @param s string to remove non printable characters from
@@ -181,7 +177,6 @@ std::string Util::CreateCleanString(std::string const &s)
 }
 
 /**
- * \ingroup Globals
  * \brief   Add a SEPARATOR to the end of the name is necessary
  * @param   pathname file/directory name to normalize 
  */
@@ -201,7 +196,6 @@ std::string Util::NormalizePath(std::string const &pathname)
 }
 
 /**
- * \ingroup Globals
  * \brief   Get the (directory) path from a full path file name
  * @param   fullName file/directory name to extract Path from
  */
@@ -223,7 +217,6 @@ std::string Util::GetPath(std::string const &fullName)
 }
 
 /**
- * \ingroup Util
  * \brief   Get the (last) name of a full path file name
  * @param   fullName file/directory name to extract end name from
  */
@@ -245,7 +238,6 @@ std::string Util::GetName(std::string const &fullName)
 } 
 
 /**
- * \ingroup Util
  * \brief   Get the current date of the system in a dicom string
  */
 std::string Util::GetCurrentDate()
@@ -258,7 +250,6 @@ std::string Util::GetCurrentDate()
 }
 
 /**
- * \ingroup Util
  * \brief   Get the current time of the system in a dicom string
  */
 std::string Util::GetCurrentTime()
@@ -286,7 +277,6 @@ std::string Util::DicomString(const char *s, size_t l)
 }
 
 /**
- * \ingroup Util
  * \brief Create a /DICOM/ string:
  * It should a of even lenght (no odd length ever)
  * It can contain as many (if you are reading this from your
@@ -310,7 +300,6 @@ std::string Util::DicomString(const char *s)
 }
 
 /**
- * \ingroup Util
  * \brief Safely compare two Dicom String:
  *        - Both string should be of even lenght
  *        - We allow padding of even lenght string by either a null 
@@ -331,7 +320,6 @@ bool Util::DicomStringEqual(const std::string &s1, const char *s2)
 
 
 /**
- * \ingroup Util
  * \brief   tells us if the processor we are working with is BigEndian or not
  */
 bool Util::IsCurrentProcessorBigEndian()
@@ -639,6 +627,9 @@ int GetMacAddrSys ( unsigned char *addr )
 #endif //__sun
 }
 
+/**
+ * \brief Gets the M.A.C. adress of the machine writting the DICOM image
+ */
 std::string Util::GetMACAddress()
 {
    // This code is the result of a long internet search to find something
@@ -668,7 +659,6 @@ std::string Util::GetMACAddress()
 }
 
 /**
- * \ingroup Util
  * \brief   Return the IP adress of the machine writting the DICOM image
  */
 std::string Util::GetIPAddress()
@@ -730,7 +720,6 @@ std::string Util::GetIPAddress()
 }
 
 /**
- * \ingroup Util
  * \brief Creates a new UID. As stipulate in the DICOM ref
  *        each time a DICOM image is create it should have 
  *        a unique identifier (URI)
@@ -756,12 +745,22 @@ std::string Util::CreateUniqueUID(const std::string &root)
    return radical;
 }
 
+/**
+ * \brief
+ * @param os ostream to write to
+ * @param val val
+ */ 
 template <class T>
 std::ostream &binary_write(std::ostream &os, const T &val)
 {
    return os.write(reinterpret_cast<const char*>(&val), sizeof val);
 }
 
+/**
+ * \brief binary_write binary_write
+ * @param os ostream to write to 
+ * @param val val
+ */ 
 std::ostream &binary_write(std::ostream &os, const uint16_t &val)
 {
 #ifdef GDCM_WORDS_BIGENDIAN
@@ -773,6 +772,11 @@ std::ostream &binary_write(std::ostream &os, const uint16_t &val)
 #endif //GDCM_WORDS_BIGENDIAN
 }
 
+/**
+ * \brief binary_write binary_write
+ * @param os ostream to write to
+ * @param val val
+ */ 
 std::ostream &binary_write(std::ostream &os, const uint32_t &val)
 {
 #ifdef GDCM_WORDS_BIGENDIAN
@@ -785,11 +789,21 @@ std::ostream &binary_write(std::ostream &os, const uint32_t &val)
 #endif //GDCM_WORDS_BIGENDIAN
 }
 
+/**
+ * \brief  binary_write binary_write
+ * @param os ostream to write to
+ * @param val val
+ */ 
 std::ostream &binary_write(std::ostream &os, const char *val)
 {
    return os.write(val, strlen(val));
 }
 
+/**
+ * \brief
+ * @param os ostream to write to
+ * @param val val
+ */ 
 std::ostream &binary_write(std::ostream &os, std::string const &val)
 {
    return os.write(val.c_str(), val.size());