From: malaterre Date: Fri, 10 Oct 2003 11:46:23 +0000 (+0000) Subject: * ENH: Generate both user and dev documentation X-Git-Tag: Version0.3.1~113 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=e1651d474779d823649657de3e5382677ddc6320;p=gdcm.git * ENH: Generate both user and dev documentation * ENH: Should work on windows too * ENH: Only one doxygen config.in file is needed --- diff --git a/CMakeLists.txt b/CMakeLists.txt index 3d35e90a..4218ea9b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -18,7 +18,7 @@ SET(GDCM_EXECUTABLE_PATH "${EXECUTABLE_OUTPUT_PATH}") #----------------------------------------------------------------------------- # datadir in CMake: -SET(GDCM_DATA_DIR "/share/gdcm" CACHE STRING +SET(GDCM_DATA_DIR "/share/gdcm" CACHE INTERNAL "Install location for data (relative to prefix).") MARK_AS_ADVANCED(GDCM_DATA_DIR) diff --git a/Doc/CMakeLists.txt b/Doc/CMakeLists.txt index 01241dd3..cfa963fe 100644 --- a/Doc/CMakeLists.txt +++ b/Doc/CMakeLists.txt @@ -18,8 +18,6 @@ SET(TARGET_DIR # DoxyInstallation.txt \ # DoxyMainPage.txt -#all-local: html.developper/index.html - IF(GDCM_DOXYGEN) # ADD_CUSTOM_COMMAND( @@ -31,16 +29,61 @@ IF(GDCM_DOXYGEN) #) # http://www.cmake.org/pipermail/cmake/2003-April/003673.html -CONFIGURE_FILE( - ${GDCM_SOURCE_DIR}/Doc/doxygen.config.in - ${GDCM_BINARY_DIR}/Doc/DoxyfileDeveloppers +# Too bad CMake doesn't support multiline "" +SET(GDCM_DOXYGEN_INPUT_COMMON + "${GDCM_SOURCE_DIR}/src ${GDCM_SOURCE_DIR}/Doc/DoxyPython.txt ${GDCM_SOURCE_DIR}/Doc/DoxyMainPage.txt ${GDCM_SOURCE_DIR}/Doc/DoxyInstallation.txt ${GDCM_SOURCE_DIR}/Doc/DoxyIntroduction.txt" +) +SET(GDCM_DOXYGEN_EXCLUDE_COMMON ) - ADD_CUSTOM_TARGET(doc +#Should rewrote this thing with FOREACH: +#----------------------------------------------------------------------------- +# Build the documentation for developpers + + SET(GDCM_HTML_OUTPUT + html.developper + ) + SET(GDCM_DOXYGEN_INPUT + "${GDCM_DOXYGEN_INPUT_COMMON} ${GDCM_SOURCE_DIR}/Doc/DoxyDevelInstal.txt" + ) + SET(GDCM_DOXYGEN_EXCLUDE + "${GDCM_DOXYGEN_EXCLUDE_COMMON} ${GDCM_SOURCE_DIR@/src/iddcmjpeg.h ${GDCM_SOURCE_DIR@/src/src/gdcmJpeg.cxx" + ) + CONFIGURE_FILE( + ${GDCM_SOURCE_DIR}/Doc/doxygen.config.in + ${GDCM_BINARY_DIR}/Doc/DoxyfileDeveloppers + IMMEDIATE + ) + + ADD_CUSTOM_TARGET(doc-developer ALL ${DOXYGEN} ${GDCM_BINARY_DIR}/Doc/DoxyfileDeveloppers) +#----------------------------------------------------------------------------- +# Build the documentation for user + + SET(GDCM_HTML_OUTPUT + html.user + ) + SET(GDCM_DOXYGEN_INPUT + "${GDCM_DOXYGEN_INPUT_COMMON}" + ) + SET(GDCM_DOXYGEN_EXCLUDE + "${GDCM_DOXYGEN_EXCLUDE_COMMON}" + ) + CONFIGURE_FILE( + ${GDCM_SOURCE_DIR}/Doc/doxygen.config.in + ${GDCM_BINARY_DIR}/Doc/DoxyfileUsers + IMMEDIATE + ) + + ADD_CUSTOM_TARGET(doc-user + ALL + ${DOXYGEN} + ${GDCM_BINARY_DIR}/Doc/DoxyfileUsers) + + INSTALL_FILES(${HTML_DIR} "\\.css$") INSTALL_FILES(${HTML_DIR} "\\.gif$") INSTALL_FILES(${HTML_DIR} "\\.html$") @@ -48,28 +91,8 @@ CONFIGURE_FILE( #INSTALL_FILES(${HTML_DIR} "\\.stop$") ENDIF(GDCM_DOXYGEN) -#if ENABLE_DOXYGEN -#html.developper/index.html: DoxyfileDeveloppers -# doxygen DoxyfileDeveloppers -#else -#html.developper/index.html: -#endif - -#clean-local: -# rm -f *~ *.bak -# rm -rf man latex html.developper rtf - -#install-data-local: html.developper -# $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) -# (installfiles=`echo html.developper/*`; \ -# if test "$$installfiles" = 'html.developper/*'; \ -# then echo '-- Nothing to install' ; \ -# else \ -# for i in $$installfiles; do \ -# echo '-- Installing '$$i ; \ -# $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ -# done; \ -# fi) +#----------------------------------------------------------------------------- +# m4 that hasn't been translated #dist-hook: # rm -rf $(distdir)/html.developper diff --git a/Doc/doxygen.config.in b/Doc/doxygen.config.in index 54d6d41a..9b925f8f 100644 --- a/Doc/doxygen.config.in +++ b/Doc/doxygen.config.in @@ -301,12 +301,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @GDCM_SOURCE_DIR@/src \ - @GDCM_SOURCE_DIR@/Doc/DoxyPython.txt \ - @GDCM_SOURCE_DIR@/Doc/DoxyMainPage.txt \ - @GDCM_SOURCE_DIR@/Doc/DoxyInstallation.txt \ - @GDCM_SOURCE_DIR@/Doc/DoxyDevelInstal.txt \ - @GDCM_SOURCE_DIR@/Doc/DoxyIntroduction.txt +INPUT = @GDCM_DOXYGEN_INPUT@ # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -327,8 +322,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 = @GDCM_SOURCE_DIR@/src/iddcmjpeg.h \ - @GDCM_SOURCE_DIR@/src/src/gdcmJpeg.cxx +EXCLUDE = @GDCM_DOXYGEN_EXCLUDE@ # 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. @@ -444,7 +438,7 @@ GENERATE_HTML = YES # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. -HTML_OUTPUT = html.developper +HTML_OUTPUT = @GDCM_HTML_OUTPUT@ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank