From 1b3c3ee9ca5817235f071fa28349682e5ed434e5 Mon Sep 17 00:00:00 2001 From: Sandy Carter <bwrsandman@gmail.com> Date: Sat, 22 Aug 2015 12:49:27 -0400 Subject: [PATCH 1/2] Add UseDoxygen to cmake Allow use of cmake . && make doc Requires UseDoxygen.cmake from http://tobias.rautenkranz.ch/cmake/doxygen/ --- .gitignore | 2 ++ CMakeLists.txt | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/.gitignore b/.gitignore index 8f43f9877..59d163269 100644 --- a/.gitignore +++ b/.gitignore @@ -28,3 +28,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 # ############################################ From 651f225ae01d05e65da626c973c49fee18615d7e Mon Sep 17 00:00:00 2001 From: Sandy Carter <bwrsandman@gmail.com> Date: Sun, 23 Aug 2015 22:23:20 -0400 Subject: [PATCH 2/2] Add doc build instructions in linux readme --- README.linux | 11 +++++++++++ 1 file changed, 11 insertions(+) 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