dallasgroot/0ad
1
0
Fork 0
mirror of https://gitea.wildfiregames.com/0ad/0ad synced 2026-08-15 14:43:32 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add the doxygen cmake file to the CMake Project

Browse source 
Make the docs its own target instead of a project. Dont add the
new docs target to ALL. Add an option to disable generating the
docs.
Update doxygen_awesome to v2.4.2.
Update README to reflect new changes.
This commit is contained in:
Cayleb-Ordo 2025-02-19 21:45:43 +01:00
parent c5dffb0dc9
commit 853472586f
3 changed files with 65 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CMakeLists.txt
View file

@ -4,6 +4,7 @@ project(0ad VERSION 0.29.0)
# Available Options # Available Options
option(android "Use non-working Android cross-compiling mode") option(android "Use non-working Android cross-compiling mode")
option(build-docs "Enable building the doxygen documentation(requires Network access)")
option(coverage "Enable code coverage data collection (GCC only)") option(coverage "Enable code coverage data collection (GCC only)")
option(gles "Use non-working OpenGL ES 2.0 mode") option(gles "Use non-working OpenGL ES 2.0 mode")
option(jenkins-tests "Configure CxxTest to use the XmlPrinter runner which produces Jenkins-compatible output") option(jenkins-tests "Configure CxxTest to use the XmlPrinter runner which produces Jenkins-compatible output")
@ -144,3 +145,8 @@ include(0ad-BuildFlags)
if(CMAKE_SYSTEM_NAME STREQUAL "Windows") if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
include(SetupWindowsLibs) include(SetupWindowsLibs)
endif() endif()
# Add doxygen target
if(build-docs)
add_subdirectory(${CMAKE_SOURCE_DIR}/docs/doxygen)
endif()

6
docs/README.md
View file

@ -6,7 +6,11 @@
## Building the Doxygen documentation ## Building the Doxygen documentation
To generate the Doxygen documentation: run "cmake -S . -B output && cmake --build output". To generate the Doxygen documentation:
```console
cmake -S 0ad/rootdir -B output && cmake --build output --target docs
```
If you build the documentation with cmake, the output is located in the folder html inside your If you build the documentation with cmake, the output is located in the folder html inside your
specified build directory. specified build directory.

106
docs/doxygen/CMakeLists.txt
View file

@ -1,64 +1,66 @@
cmake_minimum_required(VERSION 3.18.4...3.28.0) cmake_minimum_required(VERSION 3.25.1...4.0.0)
project(Pyrogenesis DESCRIPTION "Pyrogenesis, a RTS Engine" LANGUAGES NONE)
# Check if Doxygen and graphviz are installed. # Check if Doxygen and graphviz are installed.
find_package(Doxygen 1.9.1 REQUIRED dot) find_package(Doxygen 1.9.1 REQUIRED dot)
if(DOXYGEN_FOUND) if(DOXYGEN_FOUND)
include(FetchContent) include(FetchContent)
FetchContent_Declare(doxygen_awesome_css message(STATUS "Fetching doxygen_awesome_css")
GIT_REPOSITORY https://github.com/jothepro/doxygen-awesome-css FetchContent_Declare(doxygen_awesome_css
GIT_TAG v2.3.3 GIT_REPOSITORY https://github.com/jothepro/doxygen-awesome-css
SOURCE_DIR ${CMAKE_CURRENT_BINARY_DIR}/styling GIT_TAG v2.4.2
) SOURCE_DIR ${CMAKE_CURRENT_BINARY_DIR}/styling
FetchContent_MakeAvailable(doxygen_awesome_css) )
FetchContent_MakeAvailable(doxygen_awesome_css)
# Get current Branch Name to set it as the Project Number. # Get current Branch Name to set it as the Project Number.
find_package(Git) find_package(Git)
if(Git_FOUND) if(Git_FOUND)
set(ENV{GIT_DISCOVERY_ACROSS_FILESYSTEM} 1) set(ENV{GIT_DISCOVERY_ACROSS_FILESYSTEM} 1)
execute_process(COMMAND "${GIT_EXECUTABLE}" rev-parse --is-inside-work-tree OUTPUT_VARIABLE IS_GIT OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET) execute_process(COMMAND "${GIT_EXECUTABLE}" rev-parse --is-inside-work-tree OUTPUT_VARIABLE IS_GIT OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)
if(IS_GIT) if(IS_GIT)
execute_process(COMMAND "${GIT_EXECUTABLE}" rev-parse --abbrev-ref HEAD OUTPUT_VARIABLE CURRENT_BRANCH OUTPUT_STRIP_TRAILING_WHITESPACE) execute_process(COMMAND "${GIT_EXECUTABLE}" rev-parse --abbrev-ref HEAD OUTPUT_VARIABLE CURRENT_BRANCH OUTPUT_STRIP_TRAILING_WHITESPACE)
endif() endif()
endif() endif()
# Doxygen Configuration. # Doxygen Configuration.
if(CURRENT_BRANCH) set(DOXYGEN_PROJECT_NAME "Pyrogenesis")
set(DOXYGEN_PROJECT_NUMBER ${CURRENT_BRANCH}) set(DOXYGEN_PROJECT_BRIEF "Pyrogenesis, a RTS Engine")
else() if(CURRENT_BRANCH)
set(DOXYGEN_PROJECT_NUMBER main) set(DOXYGEN_PROJECT_NUMBER ${CURRENT_BRANCH})
endif() else()
set(DOXYGEN_PROJECT_LOGO ${CMAKE_CURRENT_SOURCE_DIR}/pyrogenesis.png) set(DOXYGEN_PROJECT_NUMBER main)
set(DOXYGEN_TAB_SIZE 4) endif()
set(DOXYGEN_EXCLUDE_PATTERNS */.svn* */tests/test_*) set(DOXYGEN_PROJECT_LOGO ${CMAKE_CURRENT_SOURCE_DIR}/pyrogenesis.png)
set(DOXYGEN_INCLUDE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../source) set(DOXYGEN_TAB_SIZE 4)
set(DOXYGEN_EXAMPLE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../source) set(DOXYGEN_EXCLUDE_PATTERNS */.svn* */tests/test_*)
set(DOXYGEN_EXCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/../../source/tools ${CMAKE_CURRENT_SOURCE_DIR}/../../source/third_party) set(DOXYGEN_INCLUDE_PATH ${CMAKE_SOURCE_DIR}/source)
set(DOXYGEN_GENERATE_TREEVIEW YES) set(DOXYGEN_EXAMPLE_PATH ${CMAKE_SOURCE_DIR}/source)
set(DOXYGEN_HTML_EXTRA_STYLESHEET ${doxygen_awesome_css_SOURCE_DIR}/doxygen-awesome.css ${CMAKE_CURRENT_SOURCE_DIR}/style.css) set(DOXYGEN_EXCLUDE ${CMAKE_SOURCE_DIR}/source/tools ${CMAKE_SOURCE_DIR}/source/third_party)
set(DOXYGEN_JAVADOC_AUTOBRIEF YES) set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_EXTRACT_ALL YES) set(DOXYGEN_HTML_EXTRA_STYLESHEET ${doxygen_awesome_css_SOURCE_DIR}/doxygen-awesome.css ${CMAKE_CURRENT_SOURCE_DIR}/style.css)
set(DOXYGEN_EXTRACT_PRIVATE YES) set(DOXYGEN_JAVADOC_AUTOBRIEF YES)
set(DOXYGEN_EXTRACT_STATIC YES) set(DOXYGEN_EXTRACT_ALL YES)
set(DOXYGEN_EXTRACT_ANON_NSPACES YES) set(DOXYGEN_EXTRACT_PRIVATE YES)
set(DOXYGEN_SHOW_DIRECTORIES YES) set(DOXYGEN_EXTRACT_STATIC YES)
set(DOXYGEN_STRIP_CODE_COMMENTS NO) set(DOXYGEN_EXTRACT_ANON_NSPACES YES)
set(DOXYGEN_MACRO_EXPANSION YES) set(DOXYGEN_SHOW_DIRECTORIES YES)
set(DOXYGEN_EXPAND_ONLY_PREDEF YES) set(DOXYGEN_STRIP_CODE_COMMENTS NO)
set(DOXYGEN_GENERATE_TODOLIST NO) set(DOXYGEN_MACRO_EXPANSION YES)
set(DOXYGEN_PREDEFINED "UNUSED(x)=x" "METHODDEF(x)=static x" "GLOBAL(x)=x") set(DOXYGEN_EXPAND_ONLY_PREDEF YES)
set(DOXYGEN_EXPAND_AS_DEFINED DEFAULT_COMPONENT_ALLOCATOR DEFAULT_SCRIPT_WRAPPER DEFAULT_INTERFACE_WRAPPER DEFAULT_MESSAGE_IMPL MESSAGE INTERFACE COMPONENT GUISTDTYPE) set(DOXYGEN_GENERATE_TODOLIST NO)
set(DOXYGEN_WARN_LOGFILE doxygen.log) set(DOXYGEN_PREDEFINED "UNUSED(x)=x" "METHODDEF(x)=static x" "GLOBAL(x)=x")
set(DOXYGEN_EXPAND_AS_DEFINED DEFAULT_COMPONENT_ALLOCATOR DEFAULT_SCRIPT_WRAPPER DEFAULT_INTERFACE_WRAPPER DEFAULT_MESSAGE_IMPL MESSAGE INTERFACE COMPONENT GUISTDTYPE)
set(DOXYGEN_WARN_LOGFILE doxygen.log)
doxygen_add_docs(${CMAKE_PROJECT_NAME} doxygen_add_docs(docs
${CMAKE_CURRENT_SOURCE_DIR}/../../source ${CMAKE_SOURCE_DIR}/source
${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox ${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox
${CMAKE_CURRENT_SOURCE_DIR}/../../LICENSE.md ${CMAKE_SOURCE_DIR}/LICENSE.md
ALL) COMMENT "Creating Doxygen for the engine."
)
else() else()
message(SEND_ERROR "Make sure Doxygen is installed and usable") message(SEND_ERROR "Make sure Doxygen is installed and usable")
endif() endif()