UseDoxygen.cmake

Run Doxygen from CMake.

Download

UseDoxygen-1.3.3.tar.gz

Darcs

darcs get http://tobias.rautenkranz.ch/cmake/doxygen

Documentation

• UseDoxygen: 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 a 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.
  

  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.
  

  
  

  CONFIGURATION
  

  To configure Doxygen you can edit Doxyfile.in and set some variables in cmake. Variables you may define are:
  

    DOXYFILE_SOURCE_DIR - Path where the Doxygen input files are.
        Defaults to the current source directory.
    DOXYFILE_EXTRA_SOURCES - Additional source diretories/files for Doxygen to scan.
           The Paths should be in double quotes and separated by space. e.g.:
           "${CMAKE_CURRENT_BINARY_DIR}/foo.c" "${CMAKE_CURRENT_BINARY_DIR}/bar/"
    
    DOXYFILE_OUTPUT_DIR - Path where the Doxygen output is stored.
       Defaults to "${CMAKE_CURRENT_BINARY_DIR}/doc".
    
    DOXYFILE_LATEX - ON/OFF; Set to "ON" if you want the LaTeX documentation
      to be built.
    DOXYFILE_LATEX_DIR - Directory relative to DOXYFILE_OUTPUT_DIR where
            the Doxygen LaTeX output is stored. Defaults to "latex".
    
    DOXYFILE_HTML_DIR - Directory relative to DOXYFILE_OUTPUT_DIR where
         the Doxygen html output is stored. Defaults to "html".
  
  

  
  

News

2011.07.16:

1.3.3; changes:

• Graphical class hieracy also for HTML output when Dot is present

2011.06.05:

1.3.2; changes:

• Fix DOXYFILE_SOURCE_DIRS

2011.03.11:

1.3.1; changes:

• Fix building the documentation from a subdirectory.

2011.01.21:

1.3; changes:

• Cache DOXYFILE variables; allows GUI configuration.

2010.08.08:

1.2; changes:

• Allow to specify source files with DOXYFILE_SOURCE_DIR

• Allow to disable LaTex build with DOXYFILE_LATEX

• Quiter doxygen run

2010.03.31:

1.1; changes:

• Fix find Doxyfile.in

2009.04.14:

Release 1.0; changes:

• Fix setting DOXYFILE_OUTPUT_DIR having no effect