Blame BUILD.txt

Packit 1c1d7e
Doxygen uses cmake (http://www.cmake.org/) to build executables for various platforms.
Packit 1c1d7e
It's required at least cmake version 2.8.12
Packit 1c1d7e
Packit 1c1d7e
The first step is to create a build directory where the output should be stored.
Packit 1c1d7e
Doxygen can be fully build outside of the source tree.
Packit 1c1d7e
Packit 1c1d7e
The second step is to invoke cmake from within the build directory with the desired generator.
Packit 1c1d7e
Packit 1c1d7e
For Linux/Unix systems do the following
Packit 1c1d7e
Packit 1c1d7e
  mkdir build
Packit 1c1d7e
  cd build
Packit 1c1d7e
  cmake -G "Unix Makefiles" path/to/root/of/doxygen/source/tree
Packit 1c1d7e
  make
Packit 1c1d7e
Packit 1c1d7e
This also works for MacOSX, but if XCode is installed you can also generate an XCode project file
Packit 1c1d7e
Packit 1c1d7e
  cmake -G XCode path/to/root/of/doxygen/source/tree
Packit 1c1d7e
Packit 1c1d7e
For Windows one can generate a Visual Studio project using
Packit 1c1d7e
Packit 1c1d7e
  cmake -G "Visual Studio 12 2013" path\to\root\of\doxygen\source\tree
Packit 1c1d7e
Packit 1c1d7e
(this is for Visual Studio 12, there are typically also generators for other versions of
Packit 1c1d7e
Visual Studio or other compiler environments like MinGW)
Packit 1c1d7e
Packit 1c1d7e
Doxygen's cmake configuration provides a number of options:
Packit 1c1d7e
- build_wizard    Build the GUI frontend for doxygen.
Packit 1c1d7e
- build_app       Example showing how to embed doxygen in an application.
Packit 1c1d7e
- build_parse     Parses source code and dumps the dependencies between the code elements.
Packit 1c1d7e
- build_xmlparser Example showing how to parse doxygen's XML output.
Packit 1c1d7e
- build_search    Build external search tools (doxysearch and doxyindexer).
Packit 1c1d7e
- build_doc       Build user manual.
Packit 1c1d7e
- use_sqlite3     Add support for sqlite3 output [experimental].
Packit 1c1d7e
- use_libclang    Add support for libclang parsing.
Packit 1c1d7e
- win_static      Link with /MT in stead of /MD on windows.
Packit 1c1d7e
- english_only    Only compile in support for the English language.
Packit 1c1d7e
- force_qt4       Forces doxywizard to build using Qt4 even if Qt5 is installed
Packit 1c1d7e
Packit 1c1d7e
An option can be turned on, by adding -D<option>=ON as a command line option, this can be
Packit 1c1d7e
done when generating the initial build files, but also afterwards, i.e. to enable building
Packit 1c1d7e
of the documentation after an initial cmake -G run, do
Packit 1c1d7e
Packit 1c1d7e
  cmake -Dbuild_doc=ON path/to/root/of/doxygen/source/tree
Packit 1c1d7e
Packit 1c1d7e
To turn the option off use
Packit 1c1d7e
Packit 1c1d7e
  cmake -Dbuild_doc=OFF path/to/root/of/doxygen/source/tree
Packit 1c1d7e
Packit 1c1d7e
To see the current value is of the various options, you can run
Packit 1c1d7e
Packit 1c1d7e
  cmake -L path/to/root/of/doxygen/source/tree
Packit 1c1d7e
Packit 1c1d7e
The build target for building the documentation is 'docs' and the build target for
Packit 1c1d7e
the regression tests is 'tests'