cmake/Modules/FindDoxygen.cmake
author Tero Marttila <terom@fixme.fi>
Thu, 28 May 2009 01:17:36 +0300
branchnew-lib-errors
changeset 219 cefec18b8268
parent 186 33ef336dbb4b
permissions -rw-r--r--
some of the lib/transport stuff compiles
59
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     1
#
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     2
# This module looks for Doxygen executable 
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     3
# and the Graphviz dot executable 
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     4
# which could be used to generate html 
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     5
# and graphical documentaton from source code. 
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
# 
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     7
# It will set the following variables:
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     8
#
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     9
#  DOXYGEN_FOUND
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    10
#  DOXYGEN_EXECUTABLE
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    11
#
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    12
#  DOXYGEN_DOT_FOUND
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    13
#  DOXYGEN_DOT_EXECUTABLE
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
#  DOXYGEN_DOT_EXECUTABLE_PATH
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    15
#
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    16
# see:
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    17
#  www.doxygen.org
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    18
#  www.research.att.com/sw/tools/graphviz/
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    19
#
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    20
# adapted from:
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    21
#  www.mip.informatik.uni-kiel.de/~jw/cmake/CMakeModules/FindDoxygen.cmake
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    22
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    23
FIND_PROGRAM (DOXYGEN_EXECUTABLE
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    24
    NAMES doxygen
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    25
    DOC "Path to doxygen binary"
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    26
    PATHS $ENV{DOXYGEN_HOME}
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    27
)
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    28
#MESSAGE(STATUS "DBG DOXYGEN_EXECUTABLE=${DOXYGEN_EXECUTABLE}")
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    29
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    30
FIND_PROGRAM (DOXYGEN_DOT_EXECUTABLE
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    31
    NAMES dot
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    32
    DOC "Path to dot binary from Graphiz (for doxygen)"
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    33
    PATHS $ENV{DOT_HOME}
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    34
)
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
#MESSAGE(STATUS "DBG DOXYGEN_DOT_EXECUTABLE=${DOXYGEN_DOT_EXECUTABLE}")
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    36
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    37
IF (DOXYGEN_EXECUTABLE)
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    38
    SET (DOXYGEN_FOUND TRUE)
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    39
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    40
    MESSAGE (STATUS "Found Doxygen at ${DOXYGEN_EXECUTABLE}")
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    41
ENDIF (DOXYGEN_EXECUTABLE)
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    42
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    43
IF (DOXYGEN_DOT_EXECUTABLE)
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    44
    SET (DOXYGEN_DOT_FOUND TRUE)  
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    45
    
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    46
    MESSAGE (STATUS "Found Dot at ${DOXYGEN_DOT_EXECUTABLE}")
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    47
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    48
    # the directory of dot is required in doxygen.config: DOT_PATH
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    49
    GET_FILENAME_COMPONENT (DOXYGEN_DOT_EXECUTABLE_PATH ${DOXYGEN_DOT_EXECUTABLE} PATH)
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    50
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    51
ENDIF (DOXYGEN_DOT_EXECUTABLE)
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    52
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    53
# hide
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    54
MARK_AS_ADVANCED (
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    55
    DOXYGEN_EXECUTABLE
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    56
    DOXYGEN_DOT_EXECUTABLE
186
33ef336dbb4b rework CMake scripts, particularly re make: Nothing to be done for `test'., integrate lcov now
Tero Marttila <terom@fixme.fi>
parents: 59
diff changeset
    57
    DOXYGEN_DOT_EXECUTABLE_DIR
59
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    58
)
375a3b5c3a46 add CMake build stuff... that was easy
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    59