1# Copyright (c) 2015, Intel Corporation
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without modification,
5# are permitted provided that the following conditions are met:
6#
7# 1. Redistributions of source code must retain the above copyright notice, this
8# list of conditions and the following disclaimer.
9#
10# 2. Redistributions in binary form must reproduce the above copyright notice,
11# this list of conditions and the following disclaimer in the documentation and/or
12# other materials provided with the distribution.
13#
14# 3. Neither the name of the copyright holder nor the names of its contributors
15# may be used to endorse or promote products derived from this software without
16# specific prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
22# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29
30option(DOXYGEN
31       "Enable doxygen generation (you still have to run 'make doc')"
32       OFF)
33
34include(CMakeDependentOption)
35# Only present DOXYGEN_GRAPHS if DOXYGEN is ON and if so, default to ON.
36# Else, set to OFF.
37cmake_dependent_option(DOXYGEN_GRAPHS
38       "Generate graphs in the doxygen documentation (you need the 'dot'
39       utility)"
40       ON
41       "DOXYGEN" OFF)
42
43if(DOXYGEN)
44    find_package(Doxygen REQUIRED)
45
46    if(DOXYGEN_GRAPHS AND (NOT DOXYGEN_DOT_FOUND))
47        message(SEND_ERROR "
48        The 'dot' utility was  not found;"
49        " install it or deactivate graph generation (DOXYGEN_GRAPHS=OFF).")
50    endif()
51
52    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
53       ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
54       @ONLY)
55    add_custom_target(doc
56        ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
57        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
58        COMMENT "Generating documentation with Doxygen"
59        VERBATIM)
60endif()
61