1
0
Fork 0
mirror of https://github.com/TheLartians/ModernCppStarter.git synced 2025-08-30 21:51:12 +02:00

Setup config for Pages section

This commit is contained in:
B Krishna Chaitanya 2020-07-27 16:26:14 +05:30
parent 919a07044a
commit 0f6c85d20d
5 changed files with 28 additions and 2 deletions

View file

@ -31,10 +31,15 @@ configure_file(
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
)
configure_file(
${CMAKE_CURRENT_LIST_DIR}/conf.py
${CMAKE_CURRENT_BINARY_DIR}/conf.py
)
add_custom_target(
GenerateDocs
${CMAKE_COMMAND} -E make_directory "${DOXYGEN_OUTPUT_DIRECTORY}"
COMMAND "${MCSS_SOURCE_DIR}/documentation/doxygen.py" "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile"
COMMAND "${MCSS_SOURCE_DIR}/documentation/doxygen.py" "${CMAKE_CURRENT_BINARY_DIR}/conf.py"
COMMAND echo "Docs written to: ${DOXYGEN_OUTPUT_DIRECTORY}"
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
)

View file

@ -7,7 +7,7 @@ PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
PROJECT_NUMBER = @DOXYGEN_PROJECT_VERSION@
# Add sources
INPUT = @DOXYGEN_PROJECT_ROOT@/README.md @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@/source
INPUT = @DOXYGEN_PROJECT_ROOT@/README.md @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@/source @DOXYGEN_PROJECT_ROOT@/documentation
EXTRACT_ALL = YES
RECURSIVE = YES

11
documentation/about.dox Normal file
View file

@ -0,0 +1,11 @@
/** @page about About Greeter
@tableofcontents
Everyone likes a good, personalized greeting.
@section sec An example section
This page contains the subsections @ref subsection1 and @ref subsection2.
For more info, see page @ref page2.
@subsection subsection1 The first subsection
Text.
@subsection subsection2 The second subsection
More text.
*/

6
documentation/conf.py Normal file
View file

@ -0,0 +1,6 @@
DOXYFILE = 'Doxyfile'
LINKS_NAVBAR1 = [
(None, 'pages', [(None, 'about')]),
(None, 'namespaces', []),
]

View file

@ -1,5 +1,9 @@
#pragma once
/** @file
* @brief Class @ref greeter::Greeter
*/
#include <string>
/**