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