Zilch.

[gdcm.git] / src / gdcmDicomDirElement.h

diff --git a/src/gdcmDicomDirElement.h b/src/gdcmDicomDirElement.h
index f813bca489b0fc44793e9e282fd7b0c6626117a1..0099c1dfcef13d32076b94c8ecd158dc6a49491c 100644 (file)
--- a/src/gdcmDicomDirElement.h
+++ b/src/gdcmDicomDirElement.h
@@ -10,8 +10,11 @@
 //-----------------------------------------------------------------------------
 typedef struct
 {
-       unsigned short int group;
+   /// DicomGroup number
+       unsigned short int group;
+   /// DicomElement number
        unsigned short int elem;
+   /// value (coded as a std::string) of the Element   
        std::string value;
 } gdcmElement;
 
@@ -33,24 +36,59 @@ public:
    gdcmDicomDirElement(void);
    ~gdcmDicomDirElement(void);
 
+  /**
+    * \ingroup gdcmParser
+    * \brief   canonical Printer 
+    * \sa    SetPrintLevel
+  */ 
    void Print(std::ostream &os);
-
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the META Elements of a DICOMDIR.
+ */
    ListDicomDirMetaElem    &GetDicomDirMetaElements(void)    
       {return(DicomDirMetaList);};
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the PATIENT Elements of a DICOMDIR.
+ */      
    ListDicomDirPatientElem &GetDicomDirPatientElements(void) 
       {return(DicomDirPatientList);};
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the STUDY Elements of a DICOMDIR.
+ */      
    ListDicomDirStudyElem   &GetDicomDirStudyElements(void)   
       {return(DicomDirStudyList);};
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the SERIE Elements of a DICOMDIR.
+ */
    ListDicomDirSerieElem   &GetDicomDirSerieElements(void)   
       {return(DicomDirSerieList);};
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the IMAGE Elements of a DICOMDIR.
+ */
    ListDicomDirImageElem   &GetDicomDirImageElements(void)   
       {return(DicomDirImageList);};
 
 private:
+   /// gdcmElements chained list, related to the MetaElements of DICOMDIR
    ListDicomDirMetaElem    DicomDirMetaList;
+   /// gdcmElements chained list, related to the PatientElements of DICOMDIR
    ListDicomDirPatientElem DicomDirPatientList;
+   /// gdcmElements chained list, related to the StudyElements of DICOMDIR
    ListDicomDirStudyElem   DicomDirStudyList;
+   /// gdcmElements chained list, related to the SerieElements of DICOMDIR
    ListDicomDirSerieElem   DicomDirSerieList;
+   /// gdcmElements chained list, related to the ImageElements of DICOMDIR
+   
    ListDicomDirImageElem   DicomDirImageList;
 };