Skip to content

Commit

Permalink
docs(engine): add plugin files to their groups
Browse files Browse the repository at this point in the history
  • Loading branch information
RiscadoA committed Aug 24, 2023
1 parent 9e36818 commit 74a6161
Show file tree
Hide file tree
Showing 48 changed files with 48 additions and 0 deletions.
1 change: 1 addition & 0 deletions engine/include/cubos/engine/assets/asset.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Classes @ref cubos::engine::AnyAsset and @ref cubos::engine::Asset.
/// @ingroup assets-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/assets/assets.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Resource @ref cubos::engine::Assets.
/// @ingroup assets-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/assets/bridge.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::AssetBridge.
/// @ingroup assets-plugin

/// @dir ./bridges
/// @brief @ref cubos::engine::AssetBridge implementations directory.
Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/assets/bridges/binary.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::BinaryBridge.
/// @ingroup assets-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/assets/bridges/file.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::FileBridge.
/// @ingroup assets-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/assets/bridges/json.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::JSONBridge.
/// @ingroup assets-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/assets/meta.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::AssetMeta.
/// @ingroup assets-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/assets/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup assets-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/collisions/aabb.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Component @ref cubos::engine::ColliderAABB.
/// @ingroup collisions-plugin

#pragma once

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Resource @ref cubos::engine::BroadPhaseCollisions.
/// @ingroup collisions-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/collisions/colliders/box.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Component @ref cubos::engine::BoxCollider.
/// @ingroup collisions-plugin

#pragma once

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Component @ref cubos::engine::CapsuleCollider.
/// @ingroup collisions-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/collisions/colliders/plane.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Component @ref cubos::engine::PlaneCollider.
/// @ingroup collisions-plugin

#pragma once

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Component @ref cubos::engine::SimplexCollider.
/// @ingroup collisions-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/collisions/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup collisions-plugin

/// @dir ./colliders
/// @brief Collider components directory.
Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/env_settings/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup env-settings-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/file_settings/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup file-settings-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/imgui/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup imgui-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/input/action.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::InputAction.
/// @ingroup input-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/input/axis.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::InputAxis.
/// @ingroup input-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/input/bindings.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::InputBindings.
/// @ingroup input-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/input/input.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Resource @ref cubos::engine::Input.
/// @ingroup input-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/input/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup input-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/deferred_renderer.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Renderer implementation @ref cubos::engine::DeferredRenderer.
/// @ingroup renderer-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/environment.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Resource @ref cubos::engine::RendererEnvironment.
/// @ingroup renderer-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/frame.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Resource @ref cubos::engine::RendererFrame.
/// @ingroup renderer-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/light.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/// @file
/// @brief Resource @ref cubos::engine::AmbientLight and components @ref cubos::engine::SpotLight,
/// @ref cubos::engine::DirectionalLight and @ref cubos::engine::PointLight.
/// @ingroup renderer-plugin
/// @todo Replace this file a directory with a file for each light type.

#pragma once
Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
/// @file
/// @brief Plugin entry point, resource @ref cubos::engine::ActiveCameras and components @ref
/// cubos::engine::RenderableGrid and @ref cubos::engine::Camera.
/// @ingroup renderer-plugin
/// @todo Move resources and components to their own files.

#pragma once
Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/pps/bloom.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Post processing pass implementation @ref cubos::engine::PostProcessingBloom.
/// @ingroup renderer-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/pps/copy_pass.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Post processing pass implementation @ref cubos::engine::PostProcessingCopy.
/// @ingroup renderer-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/pps/manager.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::PostProcessingManager.
/// @ingroup renderer-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/pps/pass.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::PostProcessingPass.
/// @ingroup renderer-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/renderer/renderer.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::BaseRenderer and resource @ref cubos::engine::Renderer.
/// @ingroup renderer-plugin

/// @dir ./pps
/// @brief Post processing directory.
Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/scene/bridge.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::SceneBridge.
/// @ingroup scene-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/scene/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup scene-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/scene/scene.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Class @ref cubos::engine::Scene.
/// @ingroup scene-plugin

#pragma once

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup asset-explorer-tool-plugin

#pragma once

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup entity-inspector-tool-plugin

#pragma once

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup entity-selector-tool-plugin

#pragma once

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup settings-inspector-tool-plugin

#pragma once

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup world-inspector-tool-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/transform/local_to_world.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Component @ref cubos::engine::LocalToWorld.
/// @ingroup transform-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/transform/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup transform-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/transform/position.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Component @ref cubos::engine::Position.
/// @ingroup transform-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/transform/rotation.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Component @ref cubos::engine::Rotation.
/// @ingroup transform-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/transform/scale.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// @file
/// @brief Component @ref cubos::engine::Scale.
/// @ingroup transform-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/voxels/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup voxels-plugin

#pragma once

Expand Down
1 change: 1 addition & 0 deletions engine/include/cubos/engine/window/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

/// @file
/// @brief Plugin entry point.
/// @ingroup window-plugin

#pragma once

Expand Down

0 comments on commit 74a6161

Please sign in to comment.