diff --git a/.gitignore b/.gitignore index 0fe0fb8a2..eb820ec6b 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,5 @@ ui_*.h /CPackSourceConfig.cmake build-* CMakeLists.txt.user.* +Doxyfile +doc/* diff --git a/CMakeLists.txt b/CMakeLists.txt index 28536c07c..9179cb836 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -22,6 +22,12 @@ option(ENABLE_LAUNCHER "Enable compilation of launcher" ON) option(ENABLE_TEST "Enable compilation of unit tests" OFF) option(ENABLE_PCH "Enable compilation using precompiled headers" ON) +############################################ +# Documentation section # +############################################ + +include(UseDoxygen OPTIONAL) + ############################################ # Building section # ############################################ diff --git a/README.linux b/README.linux index de1ba582b..20037b485 100644 --- a/README.linux +++ b/README.linux @@ -93,3 +93,14 @@ Go to /LIB_PATH/vcmi/AI, and type: Go to /DATA_PATH/vcmi, and type: ln -s .../trunk/source/config ln -s .../trunk/source/Mods + +IV. Compiling documentation + +To compile using Doxygen, the UseDoxygen CMake module must be installed. It can +be fetched from: http://tobias.rautenkranz.ch/cmake/doxygen/ + +Once UseDoxygen is installed, run: + cmake . + make doc + +The built documentation will be available from ./doc