BUILD.txt

   1 Doxygen uses cmake (http://www.cmake.org/) to build executables for various platforms.
   2 It's required at least cmake version 3.0.
   3
   4 The first step is to create a build directory where the output should be stored.
   5 Doxygen can be fully build outside of the source tree.
   6
   7 The second step is to invoke cmake from within the build directory with the desired generator.
   8
   9 For Linux/Unix systems do the following
  10
  11   mkdir build
  12   cd build
  13   cmake -G "Unix Makefiles" path/to/root/of/doxygen/source/tree
  14   make
  15
  16 This also works for MacOSX, but if XCode is installed you can also generate an XCode project file
  17
  18   cmake -G XCode path/to/root/of/doxygen/source/tree
  19
  20 For Windows one can generate a Visual Studio project using
  21
  22   cmake -G "Visual Studio 12 2013" path\to\root\of\doxygen\source\tree
  23
  24 (this is for Visual Studio 12, there are typically also generators for other versions of
  25 Visual Studio or other compiler environments like MinGW)
  26
  27 Doxygen's cmake configuration provides a number of options:
  28 - build_wizard    Build the GUI frontend for doxygen.
  29 - build_app       Example showing how to embed doxygen in an application.
  30 - build_xmlparser Example showing how to parse doxygen's XML output.
  31 - build_search    Build external search tools (doxysearch and doxyindexer).
  32 - build_doc       Build user manual.
  33 - use_sqlite3     Add support for sqlite3 output [experimental].
  34 - use_libclang    Add support for libclang parsing.
  35 - win_static      Link with /MT in stead of /MD on windows.
  36 - english_only    Only compile in support for the English language.
  37
  38 An option can be turned on, by adding -D<option>=ON as a command line option, this can be
  39 done when generating the initial build files, but also afterwards, i.e. to enable building
  40 of the documentation after an initial cmake -G run, do
  41
  42   cmake -Dbuild_doc=ON path/to/root/of/doxygen/source/tree
  43
  44 To turn the option off use
  45
  46   cmake -Dbuild_doc=OFF path/to/root/of/doxygen/source/tree
  47
  48 To see the current value is of the various options, you can run
  49
  50   cmake -L path/to/root/of/doxygen/source/tree
  51
  52 The build target for building the documentation is 'docs' and the build target for
  53 the regression tests is 'tests'