FIX gdcmParser::ReplaceOrCreateByNumber shouldn't seg fault any more (hope so...)

[gdcm.git] / src / gdcmObject.h

diff --git a/src/gdcmObject.h b/src/gdcmObject.h
index 9d2eca19d2c5d06265ebd3afa6850648af364593..a7b0665b20fd19e138714add5bbb89c2f484ad6e 100644 (file)
--- a/src/gdcmObject.h
+++ b/src/gdcmObject.h
@@ -14,13 +14,13 @@ class gdcmObject;
 typedef std::list<gdcmObject *> ListContent;
 
 //-----------------------------------------------------------------------------
+/**
+ * \ingroup gdcmObject
+ * \brief   Base object
+ */
 class GDCM_EXPORT gdcmObject 
 {
 public:
-   gdcmObject(ListTag::iterator begin,ListTag::iterator end,
-              TagHeaderEntryHT *ptagHT, ListTag *plistEntries); 
-   ~gdcmObject(void);
-
    /**
     * \ingroup gdcmParser
     * \brief   Sets the print level for the Dicom Header 
@@ -47,19 +47,23 @@ 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);  }
 
 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);
 
-void FillObject(std::list<gdcmElement> elemList);
+   void FillObject(std::list<gdcmElement> elemList);
 
 /**
 * \brief iterator on the first Header Entry (i.e Dicom Element), 
@@ -84,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: