]> Creatis software - bbtkGEditor.git/blob - cmake/UserBuildDoxygenDoc.cmake
1977 bbGEditor Bug New Urgent Black boxes Input/Output text is not displayed correctl...
[bbtkGEditor.git] / 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 #
7 #  This software is governed by the CeCILL-B license under French law and 
8 #  abiding by the rules of distribution of free software. You can  use, 
9 #  modify and/ or redistribute the software under the terms of the CeCILL-B 
10 #  license as circulated by CEA, CNRS and INRIA at the following URL 
11 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
12 #  or in the file LICENSE.txt.
13 #
14 #  As a counterpart to the access to the source code and  rights to copy,
15 #  modify and redistribute granted by the license, users are provided only
16 #  with a limited warranty  and the software's author,  the holder of the
17 #  economic rights,  and the successive licensors  have only  limited
18 #  liability. 
19 #
20 #  The fact that you are presently reading this means that you have had
21 #  knowledge of the CeCILL-B license and that you accept its terms.
22 # ------------------------------------------------------------------------ */  
23
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   STRING(REGEX REPLACE " " "~" DOXYGEN_OUTPUT "${DOXYGEN_OUTPUT}")
41   
42  
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   
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)