Home | History | Annotate | Download | only in doc
      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 # Only present DOXYGEN_GRAPHS if DOXYGEN is ON and if so, default to ON.
     30 # Else, set to OFF.
     31 cmake_dependent_option(DOXYGEN_GRAPHS
     32        "Generate graphs in the doxygen documentation (you need the 'dot'
     33        utility)"
     34        ON
     35        "DOXYGEN" OFF)
     36 
     37 if(DOXYGEN)
     38     find_package(Doxygen REQUIRED)
     39 
     40     if(DOXYGEN_GRAPHS AND (NOT DOXYGEN_DOT_FOUND))
     41         message(SEND_ERROR "
     42         The 'dot' utility was  not found;"
     43         " install it or deactivate graph generation (DOXYGEN_GRAPHS=OFF).")
     44     endif()
     45 
     46     configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
     47        ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
     48        @ONLY)
     49     add_custom_target(doc
     50         ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
     51         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     52         COMMENT "Generating documentation with Doxygen"
     53         VERBATIM)
     54 endif()
     55 
     56 add_subdirectory(requirements)
     57