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