docs(engine): use subtitles in plugin descs

GameDevTecnico · Aug 23, 2023 · 92cd7ed · 92cd7ed
1 parent 95e369f
commit 92cd7ed
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 16 deletions.
diff --git a/engine/include/cubos/engine/assets/plugin.hpp b/engine/include/cubos/engine/assets/plugin.hpp
@@ -15,23 +15,23 @@ namespace cubos::engine
     /// @ingroup plugins
     /// @brief Adds asset management to CUBOS.
     ///
-    /// Settings:
-    /// - `assets.io.enabled` _ whether asset I/O should be done (default: `true`).
+    /// ## Settings
+    /// - `assets.io.enabled` - whether asset I/O should be done (default: `true`).
     /// - `assets.io.path` - path to the assets directory - will be mounted to `/assets/` (default: `assets/`)
     /// - `assets.io.readOnly` - if true, the assets directory will be mounted as read-only (default: `true`)
     ///
-    /// Events:
+    /// ## Events
     /// - `AssetEvent` - (TODO) emitted when an asset is either loaded, modified or unloaded.
     ///
-    /// Resources:
+    /// ## Resources
     /// - `Assets` - the asset manager, used to access asset data.
     ///
-    /// Startup tags:
+    /// ## Startup tags
     /// - `cubos.assets.init` - initializes the assets manager and loads the meta files (after `cubos.settings`).
     /// - `cubos.assets.bridge` - systes which add bridges to the asset manager should be tagged with this.
     /// - `cubos.assets` - systems which load assets should be tagged with this.
     ///
-    /// Tags:
+    /// ## Tags
     /// - `cubos.assets.cleanup` - frees any assets no longer in use.
 
     /// @brief Plugin entry function.

diff --git a/engine/include/cubos/engine/collisions/plugin.hpp b/engine/include/cubos/engine/collisions/plugin.hpp
@@ -17,28 +17,28 @@ namespace cubos::engine
     /// @ingroup plugins
     /// @brief Adds collision detection to CUBOS.
     ///
-    /// Components:
+    /// ## Components
     /// - `BoxCollider` - holds the box collider data.
     /// - `CapsuleCollider` - holds the capsule collider data.
     /// - `PlaneCollider` - holds the plane collider data.
     /// - `SimplexCollider` - holds the simplex collider data.
     ///
-    /// Events:
+    /// ## Events
     /// - `CollisionEvent` - emitted when a collision occurs.
     /// - `TriggerEvent` - (TODO) emitted when a trigger is entered or exited.
     ///
-    /// Resources:
+    /// ## Resources
     /// - `BroadPhaseCollisions` - stores broad phase collision data.
     ///
-    /// Tags:
+    /// ## Tags
     /// - `cubos.collisions.aabb.missing` - missing aabb colliders are added.
     /// - `cubos.collisions.aabb` - collider aabbs are updated.
     /// - `cubos.collisions.broad.markers` - sweep markers are updated.
     /// - `cubos.collisions.broad.sweep` - sweep is performed.
     /// - `cubos.collisions.broad` - broad phase collision detection.
     /// - `cubos.collisions` - collisions are resolved.
     ///
-    /// Dependencies:
+    /// ## Dependencies
     /// - @ref transform-plugin
 
     /// @brief Plugin entry function.

diff --git a/engine/include/cubos/engine/input/plugin.hpp b/engine/include/cubos/engine/input/plugin.hpp
@@ -15,19 +15,19 @@ namespace cubos::engine
     /// @ingroup plugins
     /// @brief Adds input handling to CUBOS.
     ///
-    /// Bridges:
+    /// ## Bridges
     /// - `JSONBridge<InputBindings>` - registered with the `.bind` extension.
     ///
-    /// Events:
+    /// ## Events
     /// - `InputEvent` - (TODO) emitted when an input event occurs.
     ///
-    /// Resources:
+    /// ## Resources
     /// - `Input` - stateful input manager, used to query the input state.
     ///
-    /// Tags:
+    /// ## Tags
     /// - `cubos.input.update` - updates the input state.
     ///
-    /// Dependencies:
+    /// ## Dependencies
     /// - @ref assets-plugin
     /// - @ref window-plugin