From: jpr Date: Tue, 11 Jan 2005 15:15:37 +0000 (+0000) Subject: Some more Doxygenation (for Doc/html.developper/annotated.html) X-Git-Tag: Version1.0.bp~394 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=ac0c6624e5206f25f5adc7deb53f937e00e6e264;p=gdcm.git Some more Doxygenation (for Doc/html.developper/annotated.html) --- diff --git a/src/gdcmBase.h b/src/gdcmBase.h index e7b7abcc..45589730 100644 --- a/src/gdcmBase.h +++ b/src/gdcmBase.h @@ -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 @@ -25,12 +25,12 @@ 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 { diff --git a/src/gdcmBinEntry.h b/src/gdcmBinEntry.h index c0ff6fdb..e04dcf1f 100644 --- a/src/gdcmBinEntry.h +++ b/src/gdcmBinEntry.h @@ -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: diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h index 572d6f97..07b099ea 100644 --- a/src/gdcmDicomDir.h +++ b/src/gdcmDicomDir.h @@ -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 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 diff --git a/src/gdcmDicomDirElement.h b/src/gdcmDicomDirElement.h index 9a879015..ffd97fdd 100644 --- a/src/gdcmDicomDirElement.h +++ b/src/gdcmDicomDirElement.h @@ -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 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 { diff --git a/src/gdcmDicomDirImage.h b/src/gdcmDicomDirImage.h index 5731cd0e..29204297 100644 --- a/src/gdcmDicomDirImage.h +++ b/src/gdcmDicomDirImage.h @@ -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 @@ -24,7 +24,12 @@ 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(); diff --git a/src/gdcmDicomDirMeta.h b/src/gdcmDicomDirMeta.h index 8162055a..334e52fb 100644 --- a/src/gdcmDicomDirMeta.h +++ b/src/gdcmDicomDirMeta.h @@ -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: diff --git a/src/gdcmDicomDirObject.h b/src/gdcmDicomDirObject.h index e92aa3b8..c731f46e 100644 --- a/src/gdcmDicomDirObject.h +++ b/src/gdcmDicomDirObject.h @@ -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 { diff --git a/src/gdcmDicomDirPatient.h b/src/gdcmDicomDirPatient.h index 08d435cc..e33d4e15 100644 --- a/src/gdcmDicomDirPatient.h +++ b/src/gdcmDicomDirPatient.h @@ -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 @@ -24,10 +24,16 @@ namespace gdcm { class DicomDirStudy; + //----------------------------------------------------------------------------- typedef std::list ListDicomDirStudy; //----------------------------------------------------------------------------- +/** + * \ingroup DicomDirPatient + * \brief describes a PATIENT within a DICOMDIR (DicomDir) + */ + class GDCM_EXPORT DicomDirPatient : public DicomDirObject { public: diff --git a/src/gdcmDicomDirSerie.h b/src/gdcmDicomDirSerie.h index 5dbf4005..4f2f0749 100644 --- a/src/gdcmDicomDirSerie.h +++ b/src/gdcmDicomDirSerie.h @@ -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 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: diff --git a/src/gdcmDicomDirStudy.h b/src/gdcmDicomDirStudy.h index e6a1bbbb..214ba2d9 100644 --- a/src/gdcmDicomDirStudy.h +++ b/src/gdcmDicomDirStudy.h @@ -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 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: diff --git a/src/gdcmDict.h b/src/gdcmDict.h index 60a33551..ab0b99ef 100644 --- a/src/gdcmDict.h +++ b/src/gdcmDict.h @@ -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 EntryNamesList; typedef std::map > 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. diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h index ac0250ee..1658bb49 100644 --- a/src/gdcmDictEntry.h +++ b/src/gdcmDictEntry.h @@ -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 { diff --git a/src/gdcmDictSet.h b/src/gdcmDictSet.h index f725074d..cb891b82 100644 --- a/src/gdcmDictSet.h +++ b/src/gdcmDictSet.h @@ -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 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 diff --git a/src/gdcmDirList.h b/src/gdcmDirList.h index 2685ca37..207522d0 100644 --- a/src/gdcmDirList.h +++ b/src/gdcmDirList.h @@ -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 diff --git a/src/gdcmDocEntryArchive.h b/src/gdcmDocEntryArchive.h index 1f068b4c..98d30d7d 100644 --- a/src/gdcmDocEntryArchive.h +++ b/src/gdcmDocEntryArchive.h @@ -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 diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h index 88dac39b..8d74d2cf 100644 --- a/src/gdcmDocEntrySet.h +++ b/src/gdcmDocEntrySet.h @@ -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 diff --git a/src/gdcmElementSet.h b/src/gdcmElementSet.h index 030bbf56..cfc921bd 100644 --- a/src/gdcmElementSet.h +++ b/src/gdcmElementSet.h @@ -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 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: diff --git a/src/gdcmException.h b/src/gdcmException.h index 0be44e78..425ad6b9 100644 --- a/src/gdcmException.h +++ b/src/gdcmException.h @@ -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 { diff --git a/src/gdcmFile.h b/src/gdcmFile.h index da097692..219eddbb 100644 --- a/src/gdcmFile.h +++ b/src/gdcmFile.h @@ -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. */ diff --git a/src/gdcmHeader.h b/src/gdcmHeader.h index d7669250..5d8037ba 100644 --- a/src/gdcmHeader.h +++ b/src/gdcmHeader.h @@ -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 @@ -23,26 +23,6 @@ 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 diff --git a/src/gdcmPixelReadConvert.h b/src/gdcmPixelReadConvert.h index 4c0b5846..1938f890 100644 --- a/src/gdcmPixelReadConvert.h +++ b/src/gdcmPixelReadConvert.h @@ -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. */ diff --git a/src/gdcmPixelWriteConvert.h b/src/gdcmPixelWriteConvert.h index 4f3b5b39..7239238e 100644 --- a/src/gdcmPixelWriteConvert.h +++ b/src/gdcmPixelWriteConvert.h @@ -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. */ diff --git a/src/gdcmSQItem.h b/src/gdcmSQItem.h index df11a345..58d5e86f 100644 --- a/src/gdcmSQItem.h +++ b/src/gdcmSQItem.h @@ -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 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; diff --git a/src/gdcmSeqEntry.h b/src/gdcmSeqEntry.h index 2388523f..901b33e6 100644 --- a/src/gdcmSeqEntry.h +++ b/src/gdcmSeqEntry.h @@ -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 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: diff --git a/src/gdcmSerieHeader.h b/src/gdcmSerieHeader.h index 1a94d7cd..32c12f8c 100644 --- a/src/gdcmSerieHeader.h +++ b/src/gdcmSerieHeader.h @@ -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 */ diff --git a/src/gdcmTS.h b/src/gdcmTS.h index 7d222a57..e1fa5502 100644 --- a/src/gdcmTS.h +++ b/src/gdcmTS.h @@ -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 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 diff --git a/src/gdcmUtil.h b/src/gdcmUtil.h index e4490b62..b2eba37b 100644 --- a/src/gdcmUtil.h +++ b/src/gdcmUtil.h @@ -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. diff --git a/src/gdcmVR.h b/src/gdcmVR.h index 8071f48e..1b4af561 100644 --- a/src/gdcmVR.h +++ b/src/gdcmVR.h @@ -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 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 diff --git a/src/gdcmValEntry.h b/src/gdcmValEntry.h index fa2aec8f..d40e4f0d 100644 --- a/src/gdcmValEntry.h +++ b/src/gdcmValEntry.h @@ -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 {