Skip to content
Snippets Groups Projects
Commit 61a73138 authored by Stephan Schulz's avatar Stephan Schulz
Browse files

add README.md to doxygen

parent 22ad8297
Branches
Tags
No related merge requests found
...@@ -26,7 +26,7 @@ file(GLOB_RECURSE ALL_PUBLIC_HEADERS ${ALL_PUBLIC_HEADER_DIR}) ...@@ -26,7 +26,7 @@ file(GLOB_RECURSE ALL_PUBLIC_HEADERS ${ALL_PUBLIC_HEADER_DIR})
# setup configuring of doxygen # setup configuring of doxygen
# Caveat(s.schulz): Make sure there are not spaces within the paths. # 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}") string(REPLACE ";" "\" \"" DOXYGEN_INPUT_DIR "${DOXYGEN_INPUT_DIR}")
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doc/doxygen) set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doc/doxygen)
set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml) set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)
...@@ -34,7 +34,6 @@ set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) ...@@ -34,7 +34,6 @@ set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
set(DOXYGEN_INTERNAL_DOCS NO) set(DOXYGEN_INTERNAL_DOCS NO)
set(DOXYGEN_EXAMPLE_PATH ${PROJECT_SOURCE_DIR}/example) set(DOXYGEN_EXAMPLE_PATH ${PROJECT_SOURCE_DIR}/example)
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE ${PROJECT_SOURCE_DIR}/README.md)
# configure doxygen config file # configure doxygen config file
configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY) configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
......
...@@ -961,7 +961,7 @@ FILTER_SOURCE_PATTERNS = ...@@ -961,7 +961,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub # (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. # 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 # Configuration options related to source browsing
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment