From 4decbf7887dae4e94325205598c42be55c004025 Mon Sep 17 00:00:00 2001
From: Pascal Palenda <pascal.palenda@akustik.rwth-aachen.de>
Date: Mon, 27 Mar 2023 13:34:52 +0200
Subject: [PATCH] Add setting for the doc target name
---
src/BuildDoc.cmake | 16 +++++++++++++---
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/src/BuildDoc.cmake b/src/BuildDoc.cmake
index 532c378..bb149b1 100644
--- a/src/BuildDoc.cmake
+++ b/src/BuildDoc.cmake
@@ -24,6 +24,7 @@ set(IHTA_CMAKE_COMMON_DOC_LOGO ${IHTA_CMAKE_COMMON_DOC_LOGO} PARENT_SCOPE)
::
build_doc(
+ NAME genDocTarget
SOURCES <documentation-folder...>
[README_MAINPAGE <readme-file-for-main-page>]
[COLOR_STYLE <css-style-sheet>]
@@ -32,6 +33,11 @@ set(IHTA_CMAKE_COMMON_DOC_LOGO ${IHTA_CMAKE_COMMON_DOC_LOGO} PARENT_SCOPE)
[SIDEBAR_ONLY]
)
+ .. variables:: NAME
+
+ Target name for building the documentation.
+ Default is `build_doc`
+
.. variable:: SOURCES
List of folders or files to be included in the doxygen documentation
@@ -66,10 +72,14 @@ set(IHTA_CMAKE_COMMON_DOC_LOGO ${IHTA_CMAKE_COMMON_DOC_LOGO} PARENT_SCOPE)
#]=======================================================================]
macro (build_doc)
set (options SIDEBAR_ONLY)
- set (oneValueArgs README_MAINPAGE COLOR_STYLE LOGO ADD_DEV_SECTION)
+ set (oneValueArgs README_MAINPAGE COLOR_STYLE LOGO ADD_DEV_SECTION NAME)
set (multiValueArgs SOURCES)
cmake_parse_arguments (DOXY "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+ if (NOT DOXY_NAME)
+ set (DOXY_NAME build_doc)
+ endif ()
+
if (DOXYGEN_FOUND)
CPMAddPackage (
NAME doxygen-awesome
@@ -148,9 +158,9 @@ macro (build_doc)
set (DOXYGEN_ENABLED_SECTIONS DEV)
endif ()
- doxygen_add_docs (build_doc ${DOXY_SOURCES} ALL)
+ doxygen_add_docs (${DOXY_NAME} ${DOXY_SOURCES} ALL)
- set_property (TARGET build_doc PROPERTY FOLDER "utils")
+ set_property (TARGET ${DOXY_NAME} PROPERTY FOLDER "utils")
endif ()
--
GitLab