* src/gdcmDocument.[h|cxx] : comment all methods concerning a flat hash

[gdcm.git] / src / gdcmDicomDirStudy.h

diff --git a/src/gdcmDicomDirStudy.h b/src/gdcmDicomDirStudy.h
index 7ddd366631a2ea0adc2ce185bf2e875bee8458e6..214ba2d9daaa4030e2d8eac912de0fe47ef9a2e9 100644 (file)
--- 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 17:13:18 $
-  Version:   $Revision: 1.14 $
+  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
@@ -20,14 +20,19 @@
 #define GDCMDICOMDIRSTUDY_H
 
 #include "gdcmDicomDirObject.h"
-#include "gdcmDicomDirSerie.h"
+
 namespace gdcm 
 {
-
+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: