]> Creatis software - gdcm.git/commitdiff
update the doxygen scripts to -try to (Mmmm?)- allow 'user doc' generation
authorjpr <jpr>
Thu, 5 Feb 2004 15:04:55 +0000 (15:04 +0000)
committerjpr <jpr>
Thu, 5 Feb 2004 15:04:55 +0000 (15:04 +0000)
Doc/DoxyDevelInstal.txt
Doc/DoxyfileUsers
Doc/Makefile.am
src/gdcmHeaderHelper.h

index 126c9d19cdc6200b09746cddc009d8f8a6a185c3..32431ecb7a7d273b3030e95a8a97b58f714fa46e 100644 (file)
@@ -10,7 +10,7 @@
  * - test suite usage (typically after code modifications and prior to
  *   commit).
  * .
- * In the following we shall assume that gdcm is allready compiled-
+ * In the following we shall assume that gdcm is already compiled-
  * BUT not installed- in a directory named <TT>GDCM_HOME</TT>.
  * 
  * \section DoxyDevelInstalCPlusPlus Working with C++
index b42b80f5174526b1e3a1673a344f1284fa5fb006..8d756608a51315e3a82ebd9e68b7687e1b8e13cb 100644 (file)
@@ -324,7 +324,7 @@ RECURSIVE              = NO
 # excluded from the INPUT source files. This way you can easily exclude a 
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = 
+EXCLUDE                = ../src/iddcmjpeg.h ../src/gdcmJpeg.cxx
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
index 8ac7d5b8fade1a734ea52d679fc7aaea942634db..43b56dd2a0adbacb95d9d71b4dad20fbe9dd57ba 100644 (file)
@@ -10,20 +10,23 @@ EXTRA_DIST = \
   DoxyInstallation.txt \
   DoxyMainPage.txt
 
-all-local: html.developper/index.html
+all-local: html.developper/index.html html.user/index.html
 
 if ENABLE_DOXYGEN
 html.developper/index.html: DoxyfileDeveloppers
        doxygen DoxyfileDeveloppers
+html.user/index.html: DoxyfileUsers
+       doxygen DoxyfileUsers   
 else
 html.developper/index.html:
+html.user/index.html:
 endif
 
 clean-local:
        rm -f *~ *.bak
-       rm -rf man latex html.developper rtf
+       rm -rf man latex html.developper html.user rtf
 
-install-data-local: html.developper
+install-data-local: html.developper html.user
        $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
        (installfiles=`echo html.developper/*`; \
         if test "$$installfiles" = 'html.developper/*'; \
@@ -36,6 +39,6 @@ install-data-local: html.developper
         fi)
 
 dist-hook:
-       rm -rf $(distdir)/html.developper
+       rm -rf $(distdir)/html.developper $(distdir)/html.user
 
-.PHONY : html.developper latex man
+.PHONY : html.developper html.user latex man
index 7a0b01cca12153e519dadfc8e7ce3996214ead0e..9fdcffbde4ea5e682b0910a58c9bd7f4aff52527 100644 (file)
@@ -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
@@ -106,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: