From 61a73138dc4a0513682f28e887460cf4dd9b201c Mon Sep 17 00:00:00 2001
From: Stephan Schulz <stephan.schulz-x2q@rub.de>
Date: Wed, 27 Jan 2021 13:56:22 +0100
Subject: [PATCH] add README.md to doxygen
---
docs/CMakeLists.txt | 3 +--
docs/Doxyfile.in | 2 +-
2 files changed, 2 insertions(+), 3 deletions(-)
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 8139cbc..b60575a 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -26,7 +26,7 @@ file(GLOB_RECURSE ALL_PUBLIC_HEADERS ${ALL_PUBLIC_HEADER_DIR})
# setup configuring of doxygen
# Caveat(s.schulz): Make sure there are not spaces within the paths.
-set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/include ${PROJECT_SOURCE_DIR}/src ${PROJECT_SOURCE_DIR}/example)
+set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/include ${PROJECT_SOURCE_DIR}/src ${PROJECT_SOURCE_DIR}/example ${PROJECT_SOURCE_DIR}/README.md)
string(REPLACE ";" "\" \"" DOXYGEN_INPUT_DIR "${DOXYGEN_INPUT_DIR}")
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doc/doxygen)
set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)
@@ -34,7 +34,6 @@ set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
set(DOXYGEN_INTERNAL_DOCS NO)
set(DOXYGEN_EXAMPLE_PATH ${PROJECT_SOURCE_DIR}/example)
-set(DOXYGEN_USE_MDFILE_AS_MAINPAGE ${PROJECT_SOURCE_DIR}/README.md)
# configure doxygen config file
configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
index 5062818..329600d 100644
--- a/docs/Doxyfile.in
+++ b/docs/Doxyfile.in
@@ -961,7 +961,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
-USE_MDFILE_AS_MAINPAGE = "@DOXYGEN_USE_MDFILE_AS_MAINPAGE@"
+USE_MDFILE_AS_MAINPAGE = README.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
--
GitLab