Commit 894a8618 authored by Kenneth Leiter's avatar Kenneth Leiter
Browse files

COMP: Mark DOXYGEN_EXECUTABLE as unadvanced before it is found.

Make FindDoxygen REQUIRED when building documentation.
parent 088bda67
# - Run Doxygen
#
# Adds a doxygen target that runs doxygen to generate the html
# and optionally the LaTeX API documentation.
# The doxygen target is added to the doc target as dependency.
# i.e.: the API documentation is built with:
# make doc
# Adds a doxygen target that runs doxygen to generate the html and
# optionally the LaTeX API documentation. The doxygen target is added
# to the doc target as dependency. i.e.: the API documentation is
# built with: make doc
#
# USAGE: GLOBAL INSTALL
#
# Install it with:
# cmake ./ && sudo make install
# Add the following to the CMakeLists.txt of your project:
# include(UseDoxygen OPTIONAL)
# Optionally copy Doxyfile.in in the directory of CMakeLists.txt and edit it.
# Install it with: cmake ./ && sudo make install Add the following to
# the CMakeLists.txt of your project: include(UseDoxygen OPTIONAL)
# Optionally copy Doxyfile.in in the directory of CMakeLists.txt and
# edit it.
#
# USAGE: INCLUDE IN PROJECT
#
# set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR})
# include(UseDoxygen)
# Add the Doxyfile.in and UseDoxygen.cmake files to the projects source directory.
# include(UseDoxygen) Add the Doxyfile.in and UseDoxygen.cmake files
# to the projects source directory.
#
#
# Variables you may define are:
# DOXYFILE_OUTPUT_DIR - Path where the Doxygen output is stored. Defaults to "doc".
# Variables you may define are: DOXYFILE_OUTPUT_DIR - Path where the
# Doxygen output is stored. Defaults to "doc".
#
# DOXYFILE_LATEX_DIR - Directory where the Doxygen LaTeX output is stored. Defaults to "latex".
#
# DOXYFILE_HTML_DIR - Directory where the Doxygen html output is stored. Defaults to "html".
# DOXYFILE_LATEX_DIR - Directory where the Doxygen LaTeX output is
# stored. Defaults to "latex".
#
# DOXYFILE_HTML_DIR - Directory where the Doxygen html output is
# stored. Defaults to "html".
#
# Copyright (c) 2009, 2010 Tobias Rautenkranz <tobias@rautenkranz.ch>
......@@ -43,9 +42,11 @@ macro(usedoxygen_set_default name value)
endif()
endmacro()
find_package(Doxygen)
mark_as_advanced(CLEAR DOXYGEN_EXECUTABLE)
find_package(Doxygen REQUIRED)
if(DOXYGEN_FOUND)
mark_as_advanced(FORCE DOXYGEN_EXECUTABLE)
find_file(DOXYFILE_IN "Doxyfile.in"
PATHS "${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_ROOT}/Modules/"
NO_DEFAULT_PATH)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment