From 29040474f61225b7ef1ddc470c59300dc4faeb77 Mon Sep 17 00:00:00 2001 From: jpr Date: Thu, 5 Feb 2004 15:04:55 +0000 Subject: [PATCH] update the doxygen scripts to -try to (Mmmm?)- allow 'user doc' generation --- Doc/DoxyDevelInstal.txt | 2 +- Doc/DoxyfileUsers | 2 +- Doc/Makefile.am | 13 ++++++++----- src/gdcmHeaderHelper.h | 16 +++++++++++----- 4 files changed, 21 insertions(+), 12 deletions(-) diff --git a/Doc/DoxyDevelInstal.txt b/Doc/DoxyDevelInstal.txt index 126c9d19..32431ecb 100644 --- a/Doc/DoxyDevelInstal.txt +++ b/Doc/DoxyDevelInstal.txt @@ -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 GDCM_HOME. * * \section DoxyDevelInstalCPlusPlus Working with C++ diff --git a/Doc/DoxyfileUsers b/Doc/DoxyfileUsers index b42b80f5..8d756608 100644 --- a/Doc/DoxyfileUsers +++ b/Doc/DoxyfileUsers @@ -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. diff --git a/Doc/Makefile.am b/Doc/Makefile.am index 8ac7d5b8..43b56dd2 100644 --- a/Doc/Makefile.am +++ b/Doc/Makefile.am @@ -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 diff --git a/src/gdcmHeaderHelper.h b/src/gdcmHeaderHelper.h index 7a0b01cc..9fdcffbd 100644 --- 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 @@ -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: -- 2.45.1