From cb92b964d97cafd4e29759e1e5b4996ff0bc672b Mon Sep 17 00:00:00 2001 From: Harrand Date: Sun, 3 Nov 2024 16:43:15 +0000 Subject: [PATCH] [docs] remove a bunch of unnecessary cruft, making the documentation more compact. im hoping i havent accidentally removed a section used by some groups but i absolutely might have missed it. --- docs/Doxyfile | 2 +- docs/DoxygenLayout.xml | 23 ++--------------------- include/tz/topaz.hpp | 1 + 3 files changed, 4 insertions(+), 22 deletions(-) diff --git a/docs/Doxyfile b/docs/Doxyfile index 9aad923522..be59169b83 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -162,7 +162,7 @@ ABBREVIATE_BRIEF = "The $name class" \ # description. # The default value is: NO. -ALWAYS_DETAILED_SEC = NO +ALWAYS_DETAILED_SEC = YES # If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all # inherited members of a class in the documentation of that class as if those diff --git a/docs/DoxygenLayout.xml b/docs/DoxygenLayout.xml index bd97f59023..1eba072daa 100644 --- a/docs/DoxygenLayout.xml +++ b/docs/DoxygenLayout.xml @@ -146,30 +146,12 @@ - - - - - - - - - - - - - - - - - - - - + + @@ -177,7 +159,6 @@ - diff --git a/include/tz/topaz.hpp b/include/tz/topaz.hpp index fb8343e6fa..bd7eb76d88 100644 --- a/include/tz/topaz.hpp +++ b/include/tz/topaz.hpp @@ -4,6 +4,7 @@ /** * @defgroup tz API Reference + * @brief C++ API for the Topaz Engine **/ namespace tz {