# - This module looks for Doxygen and the path to Graphviz's dot # Doxygen is a documentation generation tool. Please see # http://www.doxygen.org # # This module accepts the following optional variables: # # DOXYGEN_SKIP_DOT = If true this module will skip trying to find Dot # (an optional component often used by Doxygen) # # This modules defines the following variables: # # DOXYGEN_EXECUTABLE = The path to the doxygen command. # DOXYGEN_FOUND = Was Doxygen found or not? # DOXYGEN_VERSION = The version reported by doxygen --version # # DOXYGEN_DOT_EXECUTABLE = The path to the dot program used by doxygen. # DOXYGEN_DOT_FOUND = Was Dot found or not? # DOXYGEN_DOT_PATH = The path to dot not including the executable # # #============================================================================= # Copyright 2001-2009 Kitware, Inc. # # Distributed under the OSI-approved BSD License (the "License"); # see accompanying file Copyright.txt for details. # # This software is distributed WITHOUT ANY WARRANTY; without even the # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. # See the License for more information. #============================================================================= # (To distribute this file outside of CMake, substitute the full # License text for the above reference.) # For backwards compatibility support if(Doxygen_FIND_QUIETLY) set(DOXYGEN_FIND_QUIETLY TRUE) endif() # ===== Rationale for OS X AppBundle mods below ===== # With the OS X GUI version, Doxygen likes to be installed to /Applications and # it contains the doxygen executable in the bundle. In the versions I've # seen, it is located in Resources, but in general, more often binaries are # located in MacOS. # # NOTE: The official Doxygen.app that is distributed for OS X uses non-standard # conventions. Instead of the command-line "doxygen" tool being placed in # Doxygen.app/Contents/MacOS, "Doxywizard" is placed there instead and # "doxygen" is placed in Contents/Resources. This is most likely done # so that something happens when people double-click on the Doxygen.app # package. Unfortunately, CMake gets confused by this as when it sees the # bundle it uses "Doxywizard" as the executable to use instead of # "doxygen". Therefore to work-around this issue we temporarily disable # the app-bundle feature, just for this CMake module: if(APPLE) # Save the old setting set(TEMP_DOXYGEN_SAVE_CMAKE_FIND_APPBUNDLE ${CMAKE_FIND_APPBUNDLE}) # Disable the App-bundle detection feature set(CMAKE_FIND_APPBUNDLE "NEVER") endif() # FYI: # In the older versions of OS X Doxygen, dot was included with the # Doxygen bundle. But the new versions require you to download # Graphviz.app which contains "dot" in it's bundle. # ============== End OSX stuff ================ # # Find Doxygen... # find_program(DOXYGEN_EXECUTABLE NAMES doxygen PATHS "[HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\doxygen_is1;Inno Setup: App Path]/bin" /Applications/Doxygen.app/Contents/Resources /Applications/Doxygen.app/Contents/MacOS DOC "Doxygen documentation generation tool (http://www.doxygen.org)" ) if(DOXYGEN_EXECUTABLE) execute_process(COMMAND ${DOXYGEN_EXECUTABLE} "--version" OUTPUT_VARIABLE DOXYGEN_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE) endif() include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) FIND_PACKAGE_HANDLE_STANDARD_ARGS(Doxygen REQUIRED_VARS DOXYGEN_EXECUTABLE VERSION_VAR DOXYGEN_VERSION) # # Find Dot... # if(NOT DOXYGEN_SKIP_DOT) find_program(DOXYGEN_DOT_EXECUTABLE NAMES dot PATHS "$ENV{ProgramFiles}/Graphviz 2.21/bin" "C:/Program Files/Graphviz 2.21/bin" "$ENV{ProgramFiles}/ATT/Graphviz/bin" "C:/Program Files/ATT/Graphviz/bin" [HKEY_LOCAL_MACHINE\\SOFTWARE\\ATT\\Graphviz;InstallPath]/bin /Applications/Graphviz.app/Contents/MacOS /Applications/Doxygen.app/Contents/Resources /Applications/Doxygen.app/Contents/MacOS DOC "Graphviz Dot tool for using Doxygen" ) if(DOXYGEN_DOT_EXECUTABLE) set(DOXYGEN_DOT_FOUND TRUE) # The Doxyfile wants the path to Dot, not the entire path and executable get_filename_component(DOXYGEN_DOT_PATH "${DOXYGEN_DOT_EXECUTABLE}" PATH CACHE) endif() endif() # # Backwards compatibility... # if(APPLE) # Restore the old app-bundle setting setting set(CMAKE_FIND_APPBUNDLE ${TEMP_DOXYGEN_SAVE_CMAKE_FIND_APPBUNDLE}) endif() # Maintain the _FOUND variables as "YES" or "NO" for backwards compatibility # (allows people to stuff them directly into Doxyfile with configure_file()) if(DOXYGEN_FOUND) set(DOXYGEN_FOUND "YES") else() set(DOXYGEN_FOUND "NO") endif() if(DOXYGEN_DOT_FOUND) set(DOXYGEN_DOT_FOUND "YES") else() set(DOXYGEN_DOT_FOUND "NO") endif() # For backwards compatibility support set (DOXYGEN ${DOXYGEN_EXECUTABLE} ) set (DOT ${DOXYGEN_DOT_EXECUTABLE} ) mark_as_advanced( DOXYGEN_EXECUTABLE DOXYGEN_DOT_EXECUTABLE DOXYGEN_DOT_PATH )