wt/cmake/UserBuildDoxygenDoc.cmake

   1 # ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Santé)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   8 #
   9 #  This software is governed by the CeCILL-B license under French law and
  10 #  abiding by the rules of distribution of free software. You can  use,
  11 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  12 #  license as circulated by CEA, CNRS and INRIA at the following URL
  13 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  14 #  or in the file LICENSE.txt.
  15 #
  16 #  As a counterpart to the access to the source code and  rights to copy,
  17 #  modify and redistribute granted by the license, users are provided only
  18 #  with a limited warranty  and the software's author,  the holder of the
  19 #  economic rights,  and the successive licensors  have only  limited
  20 #  liability.
  21 #
  22 #  The fact that you are presently reading this means that you have had
  23 #  knowledge of the CeCILL-B license and that you accept its terms.
  24 # ------------------------------------------------------------------------ */
  25
  26
  27
  28 MACRO(USER_BUILD_DOXYGEN_DOC NAME INPUT DOC_RELATIVE_INSTALL_PATH PREDEFINED)
  29
  30   #--------------------------------------------------------------------------
  31   SET(USE_DOXYGEN ON CACHE BOOL "" FORCE)
  32
  33   # Name
  34   SET(DOXYGEN_PROJECT_NAME "${NAME}")
  35
  36   # Inputs
  37   STRING(REGEX REPLACE ";" " " DOXYGEN_INPUT "${INPUT}")
  38
  39   # Output dirs
  40   SET(DOXYGEN_HTML_OUTPUT ".")
  41   SET(DOXYGEN_OUTPUT "${${PROJECT_NAME}_DOXYGEN_BUILD_PATH}")
  42   STRING(REGEX REPLACE " " "~" DOXYGEN_OUTPUT "${DOXYGEN_OUTPUT}")
  43
  44
  45   IF(NOT IS_DIRECTORY ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT})
  46     FILE(MAKE_DIRECTORY ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT})
  47   ENDIF(NOT IS_DIRECTORY ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT})
  48
  49   # Doc exclude
  50   SET(DOXYGEN_EXCLUDE "")
  51   STRING(REGEX REPLACE ";" " " DOXYGEN_EXCLUDE "${DOXYGEN_EXCLUDE}")
  52
  53   # Log file name
  54   SET(DOXYGEN_LOGFILE "${CMAKE_CURRENT_BINARY_DIR}/doxygen.log")
  55
  56   # Predefined symbols
  57   STRING(REGEX REPLACE ";" " " DOXYGEN_DOC_PREDEFINED "${PREDEFINED}")
  58
  59   #---------------------------------------------------------------------------
  60   # DOT verification
  61   IF(DOT)
  62     GET_FILENAME_COMPONENT(DOXYGEN_DOT_PATH ${DOT} PATH)
  63     SET(DOXYGEN_HAVE_DOT "YES")
  64   ELSE(DOT)
  65     SET(DOXYGEN_DOT_PATH "")
  66     SET(DOXYGEN_HAVE_DOT "NO")
  67   ENDIF(DOT)
  68
  69   #---------------------------------------------------------------------------
  70   # Create file and project
  71   CONFIGURE_FILE(
  72     ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.txt.in
  73     ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.txt
  74     @ONLY IMMEDIATE
  75     )
  76
  77
  78   ADD_CUSTOM_COMMAND(
  79     OUTPUT ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT}/index.html
  80     COMMAND
  81     ${DOXYGEN}
  82     ARGS
  83     ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.txt
  84     #  DEPENDS bbtk bbi
  85     )
  86
  87   ADD_CUSTOM_TARGET(doxygen_${NAME} ALL
  88     DEPENDS  ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT}/index.html
  89     )
  90
  91   INSTALL(
  92     DIRECTORY
  93     ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT}
  94     DESTINATION
  95     ${${PROJECT_NAME}_DOXYGEN_INSTALL_PATH}/${DOC_RELATIVE_INSTALL_PATH}
  96     )
  97   #--------------------------------------------------------------------------
  98 #message("user build doxygen , doxygen output = ${DOXYGEN_OUTPUT}")
  99 ENDMACRO(USER_BUILD_DOXYGEN_DOC)