X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmObject.h;h=7e842e0035b7c8ed4c3e90029b411503efd2dc84;hb=e037a39af09b4df452992e1129fa2a370171c44e;hp=2d49cf3b2be7928478c39e79d13f4813ec0298a8;hpb=9b3db5f141ec2b11eadefaa2ea2a3a20058b37f9;p=gdcm.git

diff --git a/src/gdcmObject.h b/src/gdcmObject.h
index 2d49cf3b..7e842e00 100644
--- a/src/gdcmObject.h
+++ b/src/gdcmObject.h
@@ -14,14 +14,20 @@ 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);
-
-   void SetPrintLevel(int level) { printLevel = level; };
+   /**
+    * \ingroup gdcmParser
+    * \brief   Sets the print level for the Dicom Header 
+    * \note    0 for Light Print; 1 for 'medium' Print, 2 for Heavy
+    */
+   void SetPrintLevel(int level) 
+      { printLevel = level; };
    virtual void Print(std::ostream &os = std::cout);
 
    std::string GetEntryByNumber(guint16 group, guint16 element);
@@ -41,31 +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);  }
 
-/**
- * \ingroup gdcmObject
- * \brief   Sets the iterator on the 'new' last Header Entry (i.e Dicom Element),
- *          inside the DICOMDIR chained list,
- *          related to this 'Object' 
- * \warning : NOT end user intended function
- * \todo find a trick to make this function useless.
-* @return
- */
-    ListTag::iterator SetEndObj(ListTag::iterator newEnd) 
-       { endObj=newEnd;  }       
-   
 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); 
+   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), 
@@ -90,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: