]> Creatis software - gdcm.git/blobdiff - src/gdcmObject.h
update
[gdcm.git] / src / gdcmObject.h
index 7e20d9cc9156a1c85ef02b799dc4f2d397bedb8d..7e842e0035b7c8ed4c3e90029b411503efd2dc84 100644 (file)
@@ -14,6 +14,10 @@ class gdcmObject;
 typedef std::list<gdcmObject *> ListContent;
 
 //-----------------------------------------------------------------------------
+/**
+ * \ingroup gdcmObject
+ * \brief   Base object
+ */
 class GDCM_EXPORT gdcmObject 
 {
 public:
@@ -43,13 +47,13 @@ public:
  */
    ListTag::iterator debut(void) 
       { return(beginObj);}
-/**
- * \ingroup gdcmObject
- * \brief   returns an iterator on the last Header Entry (i.e Dicom Element),
- *          inside the DICOMDIR chained list,
- *          related to this 'Object' 
- * @return
- */
+   /**
   * \ingroup gdcmObject
   * \brief   returns an iterator on the last Header Entry (i.e Dicom Element),
   *          inside the DICOMDIR chained list,
   *          related to this 'Object' 
   * @return
   */
     ListTag::iterator fin  (void) 
        { return(endObj);  }
 
@@ -57,10 +61,9 @@ protected:
  // constructor and destructor are protected to avoid end user to instanciate this class.
    gdcmObject(ListTag::iterator begin,ListTag::iterator end,
               TagHeaderEntryHT *ptagHT, ListTag *plistEntries); 
-   ~gdcmObject(void);
-
+   virtual ~gdcmObject(void);
 
-void FillObject(std::list<gdcmElement> elemList);
+   void FillObject(std::list<gdcmElement> elemList);
 
 /**
 * \brief iterator on the first Header Entry (i.e Dicom Element), 
@@ -85,12 +88,14 @@ void FillObject(std::list<gdcmElement> elemList);
 */  
    ListTag *plistEntries;
 /**
-* \brief
+* \brief detail level to be printed
 */   
    int printLevel;
    
-/// used to pass variables to FillObject function
-/// Work as 'global' variables
+   /**
+   * \brief used to pass variables to FillObject function
+   *        Works as 'global' variable
+   */
    std::list<gdcmHeaderEntry *>::iterator debInsertion, finInsertion, i,j;
 
 private: