diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt index 8abd5a3..b2a2269 100644 --- a/documentation/CMakeLists.txt +++ b/documentation/CMakeLists.txt @@ -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}" ) diff --git a/documentation/Doxyfile b/documentation/Doxyfile index 2046d71..00a2037 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -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 diff --git a/documentation/about.dox b/documentation/about.dox new file mode 100644 index 0000000..6f93f63 --- /dev/null +++ b/documentation/about.dox @@ -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. +*/ diff --git a/documentation/conf.py b/documentation/conf.py new file mode 100644 index 0000000..b81e3d9 --- /dev/null +++ b/documentation/conf.py @@ -0,0 +1,6 @@ +DOXYFILE = 'Doxyfile' + +LINKS_NAVBAR1 = [ + (None, 'pages', [(None, 'about')]), + (None, 'namespaces', []), +] diff --git a/include/greeter/greeter.h b/include/greeter/greeter.h index 394615b..66438c2 100644 --- a/include/greeter/greeter.h +++ b/include/greeter/greeter.h @@ -1,5 +1,9 @@ #pragma once +/** @file + * @brief Class @ref greeter::Greeter + */ + #include /**