games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2025-03-21 21:17:49 +02:00
Code Issues Releases Activity

Merge pull request #112 from bwrsandman/doxygen

Browse Source 
Add UseDoxygen to cmake
This commit is contained in:
Alexander Shishkin 2015-08-24 09:03:56 +03:00
commit 07d8bf9c0c
3 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -30,3 +30,5 @@ ui_*.h
/CPackSourceConfig.cmake /CPackSourceConfig.cmake
build-* build-*
CMakeLists.txt.user.* CMakeLists.txt.user.*
Doxyfile
doc/*

6
CMakeLists.txt
View File

@ -22,6 +22,12 @@ option(ENABLE_LAUNCHER "Enable compilation of launcher" ON)
option(ENABLE_TEST "Enable compilation of unit tests" OFF) option(ENABLE_TEST "Enable compilation of unit tests" OFF)
option(ENABLE_PCH "Enable compilation using precompiled headers" ON) option(ENABLE_PCH "Enable compilation using precompiled headers" ON)
############################################
# Documentation section #
############################################
include(UseDoxygen OPTIONAL)
############################################ ############################################
# Building section # # Building section #
############################################ ############################################

11
README.linux
View File

@ -93,3 +93,14 @@ Go to /LIB_PATH/vcmi/AI, and type:
Go to /DATA_PATH/vcmi, and type: Go to /DATA_PATH/vcmi, and type:
ln -s .../trunk/source/config ln -s .../trunk/source/config
ln -s .../trunk/source/Mods 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