]> Creatis software - gdcm.git/commitdiff
Some more Doxygenation (for Doc/html.developper/annotated.html)
authorjpr <jpr>
Tue, 11 Jan 2005 15:15:37 +0000 (15:15 +0000)
committerjpr <jpr>
Tue, 11 Jan 2005 15:15:37 +0000 (15:15 +0000)
29 files changed:
src/gdcmBase.h
src/gdcmBinEntry.h
src/gdcmDicomDir.h
src/gdcmDicomDirElement.h
src/gdcmDicomDirImage.h
src/gdcmDicomDirMeta.h
src/gdcmDicomDirObject.h
src/gdcmDicomDirPatient.h
src/gdcmDicomDirSerie.h
src/gdcmDicomDirStudy.h
src/gdcmDict.h
src/gdcmDictEntry.h
src/gdcmDictSet.h
src/gdcmDirList.h
src/gdcmDocEntryArchive.h
src/gdcmDocEntrySet.h
src/gdcmElementSet.h
src/gdcmException.h
src/gdcmFile.h
src/gdcmHeader.h
src/gdcmPixelReadConvert.h
src/gdcmPixelWriteConvert.h
src/gdcmSQItem.h
src/gdcmSeqEntry.h
src/gdcmSerieHeader.h
src/gdcmTS.h
src/gdcmUtil.h
src/gdcmVR.h
src/gdcmValEntry.h

index e7b7abccb0e35ddc34d079ae30910da82f49932e..455897303e5227a9ad37e9f97f35b8065c996af9 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmBase.h,v $
   Language:  C++
-  Date:      $Date: 2004/12/16 13:46:38 $
-  Version:   $Revision: 1.1 $
+  Date:      $Date: 2005/01/11 15:15:37 $
+  Version:   $Revision: 1.2 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 namespace gdcm 
 {
 //-----------------------------------------------------------------------------
-/*
+/**
  * \brief Base class of all gdcm classes
  *
- * Contains all to correctly print
- *  - Print method
- *  - SetPrintLevel method
+ * Contains the Print related methods :
+ *  - Print 
+ *  - SetPrintLevel / GetPrintLevel 
  */
 class GDCM_EXPORT Base
 {
index c0ff6fdb06be6887f4030b8d037a872e20fa3ec9..e04dcf1fdefbf0500deb27fad7c44a3da9aaf1e8 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmBinEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:26 $
-  Version:   $Revision: 1.29 $
+  Date:      $Date: 2005/01/11 15:15:37 $
+  Version:   $Revision: 1.30 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -27,11 +27,13 @@ namespace gdcm
 
 //-----------------------------------------------------------------------------
 /**
- * \ingroup BinEntry
- * \brief   The dicom header of a Dicom file contains a set of such entries
+ * \brief   Any Dicom Document (File Header or DicomDir) contains 
+ *           a set of DocEntry entries 
  *          (when successfuly parsed against a given Dicom dictionary)
- *          This one contains a 'string value'.
+ *          BinEntry is a specialisation of ValEntry (for non std::string
+ *          representable values)
  */
 class GDCM_EXPORT BinEntry  : public ValEntry
 {
 public:
index 572d6f97c6e0ef9248684b57d5d4cc75c8fee829..07b099eabb2f2c1b3e05e36a7e5e36f54891b6a5 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:33:55 $
-  Version:   $Revision: 1.44 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -42,7 +42,9 @@ typedef std::vector<Document *>  VectDocument;
 
 /**
  * \ingroup DicomDir
- * \brief    DicomDir defines an object representing a DICOMDIR in memory.
+ * \brief   DicomDir defines an object representing a DICOMDIR in memory
+ *  as a tree-like structure DicomDirPatient -> DicomDirStudy -> DicomDirSerie
+ * -> DicomDirImage
  *
  */
 class GDCM_EXPORT DicomDir: public Document
index 9a879015b5c769bad19b903fe6c89bd01dcc65ba..ffd97fdd1addac23accb35119216a6164d4c9dd6 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirElement.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.18 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.19 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -47,8 +47,8 @@ typedef std::list<Element> ListDicomDirImageElem;
 //-----------------------------------------------------------------------------
 /**
  * \ingroup DicomDirElement
- * \brief    DicomDirElement represents elements contained in a dicom dir
- *           Class for the chained lists from the file 'Dicts/DicomDir.dic'
+ * \brief   Represents elements contained in a DicomDir
+ *           class for the chained lists from the file 'Dicts/DicomDir.dic'
  */
 class GDCM_EXPORT DicomDirElement
 {
index 5731cd0ef874e5bbc7b2bf10ffc4f38935c00d95..29204297b0a9fc9e7c6deaa2a1d6ad6d5052380d 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirImage.h,v $
   Language:  C++
-  Date:      $Date: 2004/12/03 17:13:18 $
-  Version:   $Revision: 1.12 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.13 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 namespace gdcm 
 {
 //-----------------------------------------------------------------------------
-class GDCM_EXPORT DicomDirImage : public DicomDirObject
+/**
+ * \ingroup DicomDirImage
+ * \brief   describes an IMAGE within a SERIE
+ * (DicomDirSerie) of a given DICOMDIR (DicomDir)
+ */
+ class GDCM_EXPORT DicomDirImage : public DicomDirObject
 {
 public:
    DicomDirImage(); 
index 8162055a51f30573d7464a27187bdcbfb55eb352..334e52fb5c23ca44b7874c97219a61c2efb5f67d 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirMeta.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.14 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -25,6 +25,10 @@ namespace gdcm
 {
 
 //-----------------------------------------------------------------------------
+/**
+ * \ingroup DicomDirMeta
+ * \brief   Meta Elements (group 0002) of a DicomDir
+ */
 class GDCM_EXPORT DicomDirMeta : public DicomDirObject 
 {
 public:
index e92aa3b8433027f8e47b6376177bbcb1c0c1bff7..c731f46e1f0d99c0e6c69ac1b776675be1bd8f44 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirObject.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/08 15:03:59 $
-  Version:   $Revision: 1.11 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -33,7 +33,8 @@ class DicomDirObject;
 //-----------------------------------------------------------------------------
 /**
  * \ingroup DicomDirObject
- * \brief   Base object
+ * \brief   Parent object for DicomDirPatient, DicomDirStudy, 
+ *                          DicomDirSerie, DicomDirImage, of a DicomDir
  */
 class GDCM_EXPORT DicomDirObject : public SQItem
 {
index 08d435cc90df1c1d4c06562e85d2e5fcc259eba5..e33d4e15135a5c24fc1ec7c9f646eba286ec6e8c 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirPatient.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.16 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
 namespace gdcm 
 {
 class DicomDirStudy;
+
 //-----------------------------------------------------------------------------
 typedef std::list<DicomDirStudy*> ListDicomDirStudy;
 
 //-----------------------------------------------------------------------------
+/**
+ * \ingroup DicomDirPatient
+ * \brief   describes a PATIENT within a DICOMDIR (DicomDir)
+ */
+
 class GDCM_EXPORT DicomDirPatient : public DicomDirObject 
 {
 public:
index 5dbf4005ecb0ca7af06dc961948aa612a8e1d2d8..4f2f0749c7e829610bf46792ed5befb6b1cf9a62 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirSerie.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.17 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.18 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -28,6 +28,11 @@ class DicomDirImage;
 typedef std::list<DicomDirImage *> ListDicomDirImage;
 
 //-----------------------------------------------------------------------------
+/**
+ * \ingroup DicomDirSerie
+ * \brief   describes a SERIE  within a within a STUDY
+ * (DicomDirStudy) of a given DICOMDIR (DicomDir)
+ */
 class GDCM_EXPORT DicomDirSerie : public DicomDirObject 
 {
 public:
index e6a1bbbb14853ac5862ab10a2080033dee4f9bf8..214ba2d9daaa4030e2d8eac912de0fe47ef9a2e9 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirStudy.h,v $
   Language:  C++
-  Date:      $Date: 2004/12/03 20:16:57 $
-  Version:   $Revision: 1.15 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -28,6 +28,11 @@ class DicomDirSerie;
 typedef std::list<DicomDirSerie *> ListDicomDirSerie;
 
 //-----------------------------------------------------------------------------
+/**
+ * \ingroup DicomDirStudy
+ * \brief   describes a STUDY within a within a PATIENT
+ * (DicomDirPatient) of a given DICOMDIR (DicomDir)
+ */
 class GDCM_EXPORT DicomDirStudy : public DicomDirObject
 {
 public:
index 60a335513da10f050f6b6c99238e4a3d80580a30..ab0b99efc20f93a8a43261a8bc972c7855cb0b2a 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDict.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/08 15:03:59 $
-  Version:   $Revision: 1.29 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.30 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -36,8 +36,8 @@ typedef std::list<std::string>       EntryNamesList;
 typedef std::map<std::string, 
             std::list<std::string> > EntryNamesByCatMap;
 //-----------------------------------------------------------------------------
-/*
- * \defgroup Dict
+/**
+ * \ingroup Dict
  * \brief    Dict acts a memory representation of a dicom dictionary i.e.
  *           it is a container for a collection of dictionary entries.
  *           The dictionary is loaded from in an ascii file.
index ac0250ee6695b99a4f37cb6172453b300a4c0b1e..1658bb493753a40015cd8f7f5f6a36b1cd0f1ebc 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/07 16:14:58 $
-  Version:   $Revision: 1.27 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -25,15 +25,17 @@ namespace gdcm
 {
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup DictEntry
+/**
+ * \ingroup DictEntry
  * \brief
  * the DictEntry in an element contained by the Dict.
  * It contains :
  *  - the key referenced by the DICOM norm or the constructor (for private keys)
- *  - the corresponding name in english (it's equivalent to a label)
- *  - the owner group
- *  - etc.
+ *    i.e. the Group number
+ *         the Element number
+ *  - the VR (Value Representation)
+ *  - the VM (Value Multplicity)
+ *  - the corresponding name in english
  */
 class GDCM_EXPORT DictEntry : public Base
 {
index f725074dfef78b6e9fca404588bbf0e75d3377e5..cb891b82fbda8c1471a2e5e799e20ed2aff48691 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictSet.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/07 12:29:17 $
-  Version:   $Revision: 1.33 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.34 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -30,9 +30,9 @@ namespace gdcm
 typedef std::map<DictKey, Dict*> DictSetHT;
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup DictSet
- * \brief  Container for managing a set of loaded dictionaries.
+/**
+ * \ingroup DictSet
+ * \brief  Container for managing a set of loaded dictionaries (Dict).
  * \note   Hopefully, sharing dictionaries should avoid
  * \par    reloading an already loaded dictionary (saving time)
  * \par    having many in memory representations of the same dictionary
index 2685ca37d7d20bb767fd687184a264eecd3afc7e..207522d0f4de38f20a9807f1b8a08f0667ca2ef6 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDirList.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.14 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -30,7 +30,8 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 /**
  * \ingroup DirList
- * \brief   List containing the file headers from root directory. 
+ * \brief   List containing the file Header s of all the gdcm readable files
+ *          found by exploring recursively a root directory. 
  */
 // NOTE: Due to a VC6 'feature' we can not export a std::list in a dll, 
 // so GDCM_EXPORT keyword was removed for this class only
index 1f068b4cdce1c4900092549c087065a53880b724..98d30d7df25d472dd5029c4c863e3f361dfbdaf1 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntryArchive.h,v $
   Language:  C++
-  Date:      $Date: 2004/12/03 20:16:58 $
-  Version:   $Revision: 1.3 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.4 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -25,14 +25,13 @@ namespace gdcm
 {
 
 //-----------------------------------------------------------------------------
-/*
- * /brief Container 
- *
+/**
+ * \brief Container 
  * It's goal is to change the Header correctly. At this time, the change is 
  * only made for the first level of the Document. In the future, it might 
- * consider sequences.
+ * consider Dicom Sequences (SeqEntry, within any SQItem).
  * The change is made by replacing a DocEntry by an other that is created
- * outside the class. The old value is kept. When we restore the header
+ * outside the class. The old value is kept. When we restore the Header
  * status, the added DocEntry is deleted and replaced by the old value.
  */
 class GDCM_EXPORT DocEntryArchive 
index 88dac39bf795587ce479ea950f2a129defe21732..8d74d2cf5d9a1d5ac2624fcdf7f8c3bf56c8f585 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/08 15:03:59 $
-  Version:   $Revision: 1.36 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -35,6 +35,7 @@ typedef std::string BaseTagKey;
 //-----------------------------------------------------------------------------
 
 /**
+ * \brief
  * \ref DocEntrySet is an abstract base class for \ref ElementSet
  * and \ref SQItem which are both containers for DocEntries.
  * \ref ElementSet is based on the STL map<> container
index 030bbf562c07ae6b81571f68299f1f71a8154981..cfc921bd52a70c28479459d12b7c1f295afc7fe9 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.28 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.29 $
                                                                                 
   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,13 @@ class SeqEntry;
 typedef std::map<TagKey, DocEntry *> TagDocEntryHT;
 
 //-----------------------------------------------------------------------------
-
+/**
+ * \brief
+ * \ref ElementSet is based on the STL map<> container
+ * (see \ref ElementSet::TagHT), as opposed to \ref SQItem
+ * which is based on an STL list container (see \ref ListDocEntry).
+ * It contains the 'zero-level- DocEntry (out of any Dicom Sequence)
+ */
 class GDCM_EXPORT ElementSet : public DocEntrySet
 {
 public:
index 0be44e78c990f6a5231ecf571047383eabd2e76e..425ad6b9dfe32182dcf607da8fd568e7899e5306 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmException.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.20 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.21 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -29,8 +29,8 @@ namespace gdcm
 {
 
 //-----------------------------------------------------------------------------
-/*
- * Any exception thrown in the gdcm library
+/**
+ * \brief Any exception thrown in the gdcm library
  */
 class GDCM_EXPORT Exception : public std::exception
 {
@@ -80,8 +80,8 @@ protected:
 
 
 //-----------------------------------------------------------------------------
-/*
- * File error exception thrown in the gdcm library
+/**
+ * \brief File error exception thrown in the gdcm library
  */
 class GDCM_EXPORT FileError : public Exception
 {
index da097692bcaa53af0423387cdc766a2f5a3b541b..219eddbbeddbc2bf900aa1d02f39b613e760279c 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/08 15:03:59 $
-  Version:   $Revision: 1.92 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.93 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -31,8 +31,8 @@ class PixelReadConvert;
 class PixelWriteConvert;
 class DocEntryArchive;
 //-----------------------------------------------------------------------------
-/*
- * In addition to Dicom header exploration, this class is designed
+/**
+ * \brief In addition to Dicom Header exploration, this class is designed
  * for accessing the image/volume content. One can also use it to
  * write Dicom/ACR-NEMA/RAW files.
  */
index d7669250fb59ae0b782031c361de2ee4aa81448b..5d8037ba2d45d224ca0e90bf0add81797fbea56e 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmHeader.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/11 11:37:14 $
-  Version:   $Revision: 1.98 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.99 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 
 namespace gdcm 
 {
-//-----------------------------------------------------------------------------
-/**
- * \brief
- * The purpose of an instance of Header is to act as a container of
- * all the DICOM elements and their corresponding values (and
- * additionaly the corresponding DICOM dictionary entry) of the header
- * of a DICOM file.
- *
- * The typical usage of instances of class Header is to classify a set of
- * dicom files according to header information e.g. to create a file hierarchy
- * reflecting the Patient/Study/Serie informations, or extracting a given
- * SerieId. Accessing the content (image[s] or volume[s]) is beyond the
- * functionality of this class and belongs to gdmcFile.
- * \note  The various entries of the explicit value representation (VR) shall
- *        be managed within a dictionary which is shared by all Header
- *        instances.
- * \note  The Header::Set*Tag* family members cannot be defined as
- *        protected due to Swig limitations for as Has_a dependency between
- *        File and Header.
- */
 
 //-----------------------------------------------------------------------------
 // Dicom Part 3.3 Compliant
@@ -90,6 +70,26 @@ enum ModalityType {
    XA,       // X-Ray Angiography
    XC        // Photographic Imaging
 };
+
+//-----------------------------------------------------------------------------
+/**
+ * \brief DICOM elements and their corresponding values (and
+ * additionaly the corresponding DICOM dictionary entry) of the header
+ * of a DICOM file.
+ *
+ * The typical usage of instances of class Header is to classify a set of
+ * dicom files according to header information e.g. to create a file hierarchy
+ * reflecting the Patient/Study/Serie informations, or extracting a given
+ * SerieId. Accessing the content (image[s] or volume[s]) is beyond the
+ * functionality of this class and belongs to gdmcFile.
+ * \note  The various entries of the explicit value representation (VR) shall
+ *        be managed within a dictionary which is shared by all Header
+ *        instances.
+ * \note  The Header::Set*Tag* family members cannot be defined as
+ *        protected due to Swig limitations for as Has_a dependency between
+ *        File and Header.
+ */
+
 //-----------------------------------------------------------------------------
 
 class GDCM_EXPORT Header : public Document
index 4c0b5846c6ffd4f83b317a1aad64568b523e8078..1938f8906caae36001452032294e6492a97742f6 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmPixelReadConvert.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:28 $
-  Version:   $Revision: 1.9 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -29,7 +29,8 @@ namespace gdcm
 class Header;
 class RLEFramesInfo;
 class JPEGFragmentsInfo;
-/*
+
+/**
  * \brief Utility container for gathering the various forms the pixel data
  *        migth take during the user demanded processes.
  */
index 4f3b5b39a1820e0c6938c7c67ae4b0f87ee403b9..7239238ea96944be1934725adc4a7ce8af9b15b8 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmPixelWriteConvert.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:28 $
-  Version:   $Revision: 1.5 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.6 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -25,7 +25,7 @@
 
 namespace gdcm
 {
-/*
+/**
  * \brief Utility container for gathering the various forms the pixel data
  *        migth take during the user demanded processes.
  */
index df11a3456d5f5ad5bc999c8229c7c20bc369e542..58d5e86f1424217294742826d0cb86936c00a9d2 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/08 15:04:00 $
-  Version:   $Revision: 1.30 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.31 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -31,6 +31,12 @@ class DocEntry;
 //-----------------------------------------------------------------------------
 typedef std::list<DocEntry *> ListDocEntry;
 //-----------------------------------------------------------------------------
+/**
+ * \brief a SeqEntry is composed by a set of SQItems.
+ *        Each SQItem is composed by a set of DocEntry
+ *        A DocEntry may be a SeqEntry
+ *        ... and so forth 
+ */ 
 class GDCM_EXPORT SQItem : public DocEntrySet 
 {
 public:
@@ -62,16 +68,16 @@ public:
    /// \brief   Sets the ordinal position of a given SQItem
    void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
 
-   /// Accessor on \ref SQDepthLevel.
+   ///  \brief Accessor on \ref SQDepthLevel.
    int GetDepthLevel() { return SQDepthLevel; }
                                                                                 
-   /// Accessor on \ref SQDepthLevel.
+   ///  \brief Accessor on \ref SQDepthLevel.
    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
 
-   /// Accessor on \ref BaseTagKey.
+   ///  \brief Accessor on \ref BaseTagKey.
    void SetBaseTagKey( BaseTagKey const &key ) { BaseTagKeyNested = key; }
 
-   /// Accessor on \ref BaseTagKey.
+   ///  \brief Accessor on \ref BaseTagKey.
    BaseTagKey const &GetBaseTagKey() const { return BaseTagKeyNested; }
 
    void Initialize();
@@ -85,7 +91,7 @@ protected:
    /// Chained list iterator, used to visit the TagHT variable
    ListDocEntry::iterator ItDocEntries;
    
-   ///\brief pointer to the HTable of the Document,
+   /// \brief pointer to the HTable of the Document,
    ///       (because we don't know it within any DicomDirObject nor any SQItem)
    // TagDocEntryHT *PtagHT;
 
index 2388523fd09f188daff69fe942fc2c6246152468..901b33e6bf8d27081fd0ac064c55a07d392e4ea9 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSeqEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:28 $
-  Version:   $Revision: 1.26 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.27 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -29,7 +29,13 @@ class SQItem;
 //-----------------------------------------------------------------------------
 typedef std::list<SQItem *> ListSQItem;
 //-----------------------------------------------------------------------------
-
+/**
+ * \brief a SeqEntry (as opposed to a ValEntry) is a non elementary DocEntry.
+ *        It is composed by a set of SQItems.
+ *        Each SQItem is composed by a set of DocEntry
+ *        A DocEntry may be a SeqEntry
+ *        ... and so forth 
+ */ 
 class GDCM_EXPORT SeqEntry : public DocEntry 
 {
 public:
index 1a94d7cd49c545790d19cad702e0cb9014677ac0..32c12f8c194753a1c5eadcbba938ec0e0ffc01b3 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSerieHeader.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:28 $
-  Version:   $Revision: 1.3 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.4 $
                                                                                 
   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
 {
 class Header;
 //-----------------------------------------------------------------------------
-/*
- * \defgroup SerieHeader
+/**
+ * \ingroup SerieHeader
  * \brief  
- *
  * - This class should be used for a stack of 2D dicom images.
  * - For a multiframe dicom image better use directly SerieHeader
 */
index 7d222a573565acca6415c55853eb7497155ebcf5..e1fa5502982c745a89b05e6e038f6769a87b615f 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmTS.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/11 11:37:14 $
-  Version:   $Revision: 1.15 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -33,8 +33,8 @@ typedef std::string TSAtr;
 typedef std::map<TSKey, TSAtr> TSHT;    // Transfer Syntax Hash Table
 
 //-----------------------------------------------------------------------------
-/*
- * Container for dicom Transfer Syntax Hash Table
+/**
+ * \brief Container for dicom 'Transfer Syntax' Hash Table
  * \note   This is a singleton
  */
 class GDCM_EXPORT TS
index e4490b624db2866613ed47541471fb8629abd30a..b2eba37b64048a9f674353ce7b4b5c67f9b7fe8f 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmUtil.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:28 $
-  Version:   $Revision: 1.48 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.49 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -26,7 +26,7 @@
 namespace gdcm 
 {
 /**
- * \defgroup Globals Utility functions
+ * \ingroup Globals Utility functions
  * \brief    Here are some utility functions, belonging to the Util class,
  *           dealing with strings, file names... that can be called
  *           from anywhere by whomsoever they can help.
index 8071f48e4a351c29bceee970a08488ab122bdbd7..1b4af5611dcc34ab95d61a7eb731bdbc991a54ba 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmVR.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:28 $
-  Version:   $Revision: 1.17 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.18 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -34,8 +34,8 @@ typedef std::string VRAtr;
 typedef std::map<VRKey, VRAtr> VRHT;
 
 //-----------------------------------------------------------------------------
-/*
- * Container for dicom Value Representation Hash Table
+/**
+ * \brief Container for dicom Value Representation Hash Table
  * \note   This is a singleton
  */
 class GDCM_EXPORT VR 
index fa2aec8fb1cd4a071a43133433985ba7aec7e295..d40e4f0d76087cc13c9d3dd4904913def386d587 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmValEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:28 $
-  Version:   $Revision: 1.34 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  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
@@ -27,9 +27,10 @@ namespace gdcm
 {
 //-----------------------------------------------------------------------------
 /**
- * \ingroup ValEntry
- * \brief   The dicom header of a Dicom file contains a set of such entries
+ * \brief   Any Dicom Document (File Header or DicomDir) contains 
+ *           a set of DocEntry entries 
  *          (when successfuly parsed against a given Dicom dictionary)
+ *          ValEntry is an elementary DocEntry (as opposed to SeqEntry)
  */
 class GDCM_EXPORT ValEntry  : public DocEntry
 {