[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.
harrand · Nov 3, 2024 · cb92b96 · cb92b96
1 parent c6a7faf
commit cb92b96
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 22 deletions.
diff --git 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
@@ -146,38 +146,19 @@
     <groupgraph visible="$GROUP_GRAPHS"/>
     <memberdecl>
       <nestedgroups visible="yes" title=""/>
-      <dirs visible="yes" title=""/>
-      <files visible="yes" title=""/>
-      <namespaces visible="yes" title=""/>
-      <concepts visible="yes" title=""/>
-      <classes visible="yes" title=""/>
-      <defines title=""/>
       <typedefs title=""/>
-      <sequences title=""/>
-      <dictionaries title=""/>
-      <enums title=""/>
-      <enumvalues title=""/>
-      <functions title=""/>
-      <variables title=""/>
-      <signals title=""/>
-      <publicslots title=""/>
-      <protectedslots title=""/>
-      <privateslots title=""/>
-      <events title=""/>
-      <properties title=""/>
-      <friends title=""/>
-      <membergroups visible="yes"/>
+      <classes visible="yes" title=""/>
     </memberdecl>
     <memberdef>
       <pagedocs/>
+      <functions title=""/>
       <inlineclasses title=""/>
       <defines title=""/>
       <typedefs title=""/>
       <sequences title=""/>
       <dictionaries title=""/>
       <enums title=""/>
       <enumvalues title=""/>
-      <functions title=""/>
       <variables title=""/>
       <signals title=""/>
       <publicslots title=""/>

diff --git 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
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ @@
     /**
      * @defgroup tz API Reference
+     * @brief C++ API for the Topaz Engine
     **/
     namespace tz
     {
@@ Expand Down @@