🧹 Doxygen: Consolidated @defgroup commands to 'Modules.h'.

Also fixed many 'missing title' warnings. Also fixed INPUT tag.
RigsOfRods · Feb 26, 2022 · 6d8af64 · 6d8af64
1 parent 65b4cd5
commit 6d8af64
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 35 deletions.
diff --git a/doc/doxygen/Doxyfile.conf.in b/doc/doxygen/Doxyfile.conf.in
@@ -761,8 +761,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @DOXYGEN_SOURCE_DIR@/MainPage.h \
-                         @DOXYGEN_SOURCE_DIR@/Overview.h \
+INPUT                  = @DOXYGEN_SOURCE_DIR@/ \
                          @PROJECT_SOURCE_DIR@/source \
                          @PROJECT_SOURCE_DIR@/doc/angelscript
 

diff --git a/doc/doxygen/Modules.h b/doc/doxygen/Modules.h
@@ -0,0 +1,34 @@
+/// @defgroup Application Application
+/// Integration with host OS, hardware and drivers
+
+/// @defgroup GameState Game state
+/// Makes all gameplay features work together.
+
+/// @defgroup MsgQueue Message queue
+/// Ensures everything gets executed at right time & in right order.
+
+/// @defgroup Physics Physics
+/// Soft-body physics and associated simulations.
+
+/// @defgroup Collisions Collisions
+/// Static & dynamic collision detection system
+
+/// @defgroup Trucks Land vehicles
+/// Cars, trucks, rovers, ATVs, anything.
+
+/// @defgroup Aerial Aerial
+/// Airplanes and helicopters.
+
+/// @defgroup Character Character
+/// Wandering the terrain on foot.
+
+/// @defgroup Marine Marine
+/// Ships and boats of any size and function.
+
+/// @defgroup Console Console
+/// Centerpiece of the application; parses command line & config, maintains cvars, logs messages.
+
+/// @defgroup ConsoleCmd Console commmands
+/// Built-in console commands.
+
+
diff --git a/source/main/AppContext.h b/source/main/AppContext.h
@@ -35,8 +35,7 @@
 
 namespace RoR {
 
-/// @defgroup Application
-/// Integration with host OS, hardware and drivers.
+/// @addtogroup Application
 /// @{
 
 /// Central setup and event handler for input/windowing/rendering.
@@ -104,6 +103,6 @@ class AppContext: public OgreBites::WindowEventListener,
     RoR::ForceFeedback   m_force_feedback;
 };
 
-/// @} // defgroup Application
+/// @} // addtogroup Application
 
 } // namespace RoR
diff --git a/source/main/GameContext.h b/source/main/GameContext.h
@@ -40,24 +40,10 @@
 
 namespace RoR {
 
-/// @defgroup Trucks Land vehicles
-/// Cars, trucks, rovers, ATVs, anything.
-
-/// @defgroup Aerial
-/// Airplanes and helicopters.
-
-/// @defgroup Character
-/// Wandering the terrain on foot.
-
-/// @defgroup Marine
-/// Ships and boats of any size and function.
-
-/// @defgroup GameState Game state
-/// Makes all gameplay features work together.
+/// @addtogroup GameState
 /// @{
 
-/// @defgroup MsgQueue Message queue
-/// Ensures everything gets executed at right time & in right order.
+/// @addtogroup MsgQueue
 /// @{
 
 /// Unified game event system - all requests and state changes are reported using a message.
@@ -75,7 +61,7 @@ struct Message
 
 typedef std::queue < Message, std::list<Message>> GameMsgQueue;
 
-/// @} // defgroup MsgQueue
+/// @} // addtogroup MsgQueue
 
 /// Central game state manager.
 /// RoR's gameplay is quite simple in structure, it consists of:
@@ -213,6 +199,6 @@ class GameContext
     SceneMouse          m_scene_mouse;                       //!< Mouse interaction with scene
 };
 
-/// @} // defgroup GameState
+/// @} // addtogroup GameState
 
 } // namespace RoR
diff --git a/source/main/physics/Actor.h b/source/main/physics/Actor.h
@@ -34,8 +34,7 @@
 
 namespace RoR {
 
-/// @defgroup Physics
-/// Soft-body physics and associated simulations.
+/// @addtogroup Physics
 /// @{
 
 /// Softbody object; can be anything from soda can to a space shuttle
@@ -577,6 +576,6 @@ class Actor : public ZeroedMemoryAllocator
     std::deque<NetUpdate> m_net_updates; //!< Incoming stream of NetUpdates
 };
 
-/// @} // defgroup Physics
+/// @} // addtogroup Physics
 
 } // namespace RoR
diff --git a/source/main/physics/ActorManager.h b/source/main/physics/ActorManager.h
@@ -39,7 +39,7 @@
 
 namespace RoR {
 
-/// @defgroup Physics
+/// @addtogroup Physics
 /// @{
 
 /// Builds and manages softbody actors (physics on background thread, networking)

diff --git a/source/main/physics/collision/Collisions.h b/source/main/physics/collision/Collisions.h
@@ -44,8 +44,7 @@ struct eventsource_t
 /// @addtogroup Physics
 /// @{
 
-/// @defgroup Collisions
-/// Static & dynamic collision detection systems.
+/// @addtogroup Collisions
 /// @{
 
 class Collisions : public ZeroedMemoryAllocator
@@ -201,7 +200,7 @@ class Collisions : public ZeroedMemoryAllocator
 
 Ogre::Vector3 primitiveCollision(node_t* node, Ogre::Vector3 velocity, float mass, Ogre::Vector3 normal, float dt, ground_model_t* gm, float penetration = 0);
 
-/// @} // defgroup Collisions
+/// @} // addtogroup Collisions
 /// @} // addtogroup Physics
 
 } // namespace RoR
diff --git a/source/main/system/Console.h b/source/main/system/Console.h
@@ -32,8 +32,7 @@
 
 namespace RoR {
 
-/// @defgroup Console
-/// Centerpiece of the application; parses command line & config, maintains cvars, logs messages.
+/// @addtogroup Console
 /// @{
 
 /// Global game console backend. Frontend is RoR::GUI::ConsoleView.

diff --git a/source/main/system/ConsoleCmd.cpp b/source/main/system/ConsoleCmd.cpp
@@ -51,7 +51,9 @@ using namespace RoR;
 /// @{
 
 // -------------------------------------------------------------------------------------
-/// @defgroup ConsoleCmd Console commmands
+// Builtin console commands.
+
+/// @addtogroup ConsoleCmd
 /// @{
 
 class GravityCmd: public ConsoleCmd
@@ -595,8 +597,7 @@ class ClearCmd: public ConsoleCmd
     }
 };
 
-/// @} // defgroup Builtin console commands
-
+/// @} // addtogroup ConsoleCmd
 
 // -------------------------------------------------------------------------------------
 // Console integration