update the doxygen scripts to -try to (Mmmm?)- allow 'user doc' generation

[gdcm.git] / src / gdcmHeaderHelper.h

diff --git a/src/gdcmHeaderHelper.h b/src/gdcmHeaderHelper.h
index 1b9b5f396f985c2a8df33d6ad554aef4cb580de8..9fdcffbde4ea5e682b0910a58c9bd7f4aff52527 100644 (file)
--- a/src/gdcmHeaderHelper.h
+++ b/src/gdcmHeaderHelper.h
@@ -54,8 +54,11 @@ enum ModalityType {
       
 //-----------------------------------------------------------------------------
 /*
- * This class is meant to *interpret* data given from gdcmHeader
- * That is to say :
+ * \defgroup gdcmHeaderHelper
+ * \brief  
+ *
+ * - This class is meant to *interpret* data given from gdcmHeader
+ * - That is to say :
  *  - it will help other dev to link against there lib
  *  - return value instead of string
  *  - will be able to search for data at some other place
@@ -66,7 +69,9 @@ class GDCM_EXPORT gdcmHeaderHelper : public gdcmHeader {
 public:
    gdcmHeaderHelper();
    gdcmHeaderHelper(const char *filename, 
-                    bool exception_on_error = false);
+              bool  exception_on_error = false, 
+              bool  enable_sequences   = false,
+             bool  ignore_shadow      = false);
 
    int GetPixelSize();
    std::string GetPixelType();
@@ -88,7 +93,7 @@ public:
    std::string GetInstanceUID();
    
    /**
-    * change GetXImagePosition -> GetXOrigin in order not to confused reader
+    * change GetXImagePosition -> GetXOrigin in order not to confuse reader
     * -# GetXOrigin can return default value (=0) if it was not ImagePosition
     * -# Image Position is different in dicomV3 <> ACR NEMA -> better use generic
     * name
@@ -104,9 +109,12 @@ public:
 };
 
 //-----------------------------------------------------------------------------
-/**
-This class should be used for a stack of 2D dicom images.
-For a multiframe dicom image better use directly gdcmHeaderHelper
+/*
+ * \defgroup gdcmSerieHeaderHelper
+ * \brief  
+ *
+ * - This class should be used for a stack of 2D dicom images.
+ * - For a multiframe dicom image better use directly gdcmHeaderHelper
 */
 class GDCM_EXPORT gdcmSerieHeaderHelper {
 public: