diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt index b2a2269..477d8af 100644 --- a/documentation/CMakeLists.txt +++ b/documentation/CMakeLists.txt @@ -13,12 +13,13 @@ CPMAddPackage( CPMAddPackage( NAME MCSS - GITHUB_REPOSITORY mosra/m.css - GIT_TAG e6eff549fb5edeabacf01369d6b845a2a59c2ebe + GITHUB_REPOSITORY TheLartians/m.css + # using a local patch until https://github.com/mosra/m.css/pull/171 is resolved + GIT_TAG 1bf162b96d5bfefc9967a80cef138f1270ffa415 DOWNLOAD_ONLY YES ) -# ---- Doxygen + m.css ---- +# ---- Doxygen variables ---- # set Doxyfile variables set(DOXYGEN_PROJECT_NAME Greeter) diff --git a/documentation/Doxyfile b/documentation/Doxyfile index 00a2037..6313209 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -7,25 +7,24 @@ 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 @DOXYGEN_PROJECT_ROOT@/documentation +INPUT = @DOXYGEN_PROJECT_ROOT@/README.md @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@/documentation/pages EXTRACT_ALL = YES RECURSIVE = YES +OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIRECTORY@ -# We don't want local paths in the documentation -FULL_PATH_NAMES = NO +# set relative include paths +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@ # Use the README as a main page USE_MDFILE_AS_MAINPAGE = @DOXYGEN_PROJECT_ROOT@/README.md -# Create nicer looking HTML -HTML_DYNAMIC_SECTIONS = YES -GENERATE_TREEVIEW = YES - -# We don't need LaTeX generation +# We use m.css to generate the html documentation, so we only need XML output +GENERATE_XML = YES +GENERATE_HTML = NO GENERATE_LATEX = NO +XML_PROGRAMLISTING = NO +CREATE_SUBDIRS = NO -# Setup m.css -GENERATE_HTML = NO -GENERATE_XML = YES -XML_PROGRAMLISTING = NO -OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIRECTORY@ +# without this option m.css will hide all files, namespaces etc. without explicit documentation +M_SHOW_UNDOCUMENTED = YES diff --git a/documentation/about.dox b/documentation/about.dox deleted file mode 100644 index 6f93f63..0000000 --- a/documentation/about.dox +++ /dev/null @@ -1,11 +0,0 @@ -/** @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 index b81e3d9..6cc1a04 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -4,3 +4,16 @@ LINKS_NAVBAR1 = [ (None, 'pages', [(None, 'about')]), (None, 'namespaces', []), ] + +# Add your own navbar links using the code below. +# To find the valid link names, you can inspect the URL of a generated documentation site. + +# LINKS_NAVBAR1 = [ +# (None, 'pages', [(None, 'about')]), +# (None, 'namespaces', [(None, 'namespacegreeter')]), +# ] +# +# LINKS_NAVBAR2 = [ +# (None, 'annotated', [(None, 'classgreeter_1_1_greeter')]), +# (None, 'files', [(None, 'greeter_8h')]), +# ] diff --git a/documentation/pages/about.dox b/documentation/pages/about.dox new file mode 100644 index 0000000..8ca02c0 --- /dev/null +++ b/documentation/pages/about.dox @@ -0,0 +1,5 @@ +/** @page about About + @section doc ModernCppStarter Documentation + This is the auto-generated documentation for the initial project of the ModernCppStater. + It shows how we can use Doxygen to automatically build a browsable documentation for your projects. +*/ diff --git a/include/greeter/greeter.h b/include/greeter/greeter.h index 66438c2..77dfe3b 100644 --- a/include/greeter/greeter.h +++ b/include/greeter/greeter.h @@ -1,14 +1,7 @@ #pragma once -/** @file - * @brief Class @ref greeter::Greeter - */ - #include -/** - * @brief The greeter namespace - */ namespace greeter { /** Language codes to be used with the Greeter class */