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 MACRO(USER_BUILD_DOXYGEN_DOC NAME INPUT DOC_RELATIVE_INSTALL_PATH PREDEFINED)
  27
  28   #--------------------------------------------------------------------------
  29   SET(USE_DOXYGEN ON CACHE BOOL "" FORCE)
  30
  31   # Name
  32   SET(DOXYGEN_PROJECT_NAME "${NAME}")
  33
  34   # Inputs
  35   STRING(REGEX REPLACE ";" " " DOXYGEN_INPUT "${INPUT}")
  36
  37   # Output dirs
  38   SET(DOXYGEN_HTML_OUTPUT ".")
  39   SET(DOXYGEN_OUTPUT ${${PROJECT_NAME}_DOXYGEN_BUILD_PATH}/${DOC_RELATIVE_INSTALL_PATH})
  40   IF(NOT IS_DIRECTORY ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT})
  41     FILE(MAKE_DIRECTORY ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT})
  42   ENDIF(NOT IS_DIRECTORY ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT})
  43
  44   # Doc exclude
  45   SET(DOXYGEN_EXCLUDE "")
  46   STRING(REGEX REPLACE ";" " " DOXYGEN_EXCLUDE "${DOXYGEN_EXCLUDE}")
  47
  48   # Log file name
  49   SET(DOXYGEN_LOGFILE "${CMAKE_CURRENT_BINARY_DIR}/doxygen.log")
  50
  51   # Predefined symbols
  52   STRING(REGEX REPLACE ";" " " DOXYGEN_DOC_PREDEFINED "${PREDEFINED}")
  53
  54   #---------------------------------------------------------------------------
  55   # DOT verification
  56   IF(DOT)
  57     GET_FILENAME_COMPONENT(DOXYGEN_DOT_PATH ${DOT} PATH)
  58     SET(DOXYGEN_HAVE_DOT "YES")
  59   ELSE(DOT)
  60     SET(DOXYGEN_DOT_PATH "")
  61     SET(DOXYGEN_HAVE_DOT "NO")
  62   ENDIF(DOT)
  63
  64   #---------------------------------------------------------------------------
  65   # Create file and project
  66   CONFIGURE_FILE(
  67     ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.txt.in
  68     ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.txt
  69     @ONLY IMMEDIATE
  70     )
  71
  72
  73   ADD_CUSTOM_COMMAND(
  74     OUTPUT ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT}/index.html
  75     COMMAND
  76     ${DOXYGEN}
  77     ARGS
  78     ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.txt
  79     #  DEPENDS bbtk bbi
  80     )
  81
  82   ADD_CUSTOM_TARGET(doxygen_${NAME} ALL
  83     DEPENDS  ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT}/index.html
  84     )
  85
  86   INSTALL(
  87     DIRECTORY
  88     ${DOXYGEN_OUTPUT}/${DOXYGEN_HTML_OUTPUT}
  89     DESTINATION
  90     ${BBTK_DOXYGEN_INSTALL_PATH}/${DOC_RELATIVE_INSTALL_PATH}
  91     )
  92   #--------------------------------------------------------------------------
  93
  94 ENDMACRO(USER_BUILD_DOXYGEN_DOC)