From 99f1d68f54115c912b0fe3ef4455011f7713dd82 Mon Sep 17 00:00:00 2001 From: Petr Ohlidal Date: Thu, 24 Feb 2022 01:16:54 +0100 Subject: [PATCH] :books: Doxygen: + modules Gfx, Hydrax, Flex --- source/main/gfx/DustPool.h | 5 +++++ source/main/gfx/EnvironmentMap.h | 5 +++++ source/main/gfx/GfxActor.h | 5 +++++ source/main/gfx/GfxData.h | 5 +++++ source/main/gfx/GfxScene.h | 5 +++++ source/main/gfx/HydraxWater.h | 5 +++++ source/main/gfx/IWater.h | 5 +++++ source/main/gfx/MovableText.h | 5 +++++ source/main/gfx/Renderdash.h | 5 +++++ source/main/gfx/ShadowManager.h | 5 +++++ source/main/gfx/Skidmark.h | 5 +++++ source/main/gfx/SkyManager.h | 5 +++++ source/main/gfx/SkyXManager.h | 7 ++++++- source/main/gfx/Water.h | 5 +++++ source/main/gfx/hydrax/CfgFileManager.h | 9 +++++++++ source/main/gfx/hydrax/DecalsManager.h | 6 ++++++ source/main/gfx/hydrax/Enums.h | 6 ++++++ source/main/gfx/hydrax/FFT.h | 6 ++++++ source/main/gfx/hydrax/GPUNormalMapManager.h | 9 +++++++++ source/main/gfx/hydrax/GodRaysManager.h | 6 ++++++ source/main/gfx/hydrax/Help.h | 9 +++++++++ source/main/gfx/hydrax/Hydrax.h | 9 +++++++++ source/main/gfx/hydrax/Image.h | 9 ++++++++- source/main/gfx/hydrax/MaterialManager.h | 9 +++++++++ source/main/gfx/hydrax/Mesh.h | 9 +++++++++ source/main/gfx/hydrax/Module.h | 9 +++++++++ source/main/gfx/hydrax/Noise.h | 9 +++++++++ source/main/gfx/hydrax/Perlin.h | 9 +++++++++ source/main/gfx/hydrax/PressurePoint.h | 9 +++++++++ source/main/gfx/hydrax/ProjectedGrid.h | 9 +++++++++ source/main/gfx/hydrax/RadialGrid.h | 9 +++++++++ source/main/gfx/hydrax/Real.h | 8 ++++++++ source/main/gfx/hydrax/RttManager.h | 9 +++++++++ source/main/gfx/hydrax/SimpleGrid.h | 9 +++++++++ source/main/gfx/hydrax/TextureManager.h | 9 +++++++++ source/main/gfx/hydrax/Wave.h | 9 +++++++++ source/main/physics/flex/FlexBody.h | 9 +++++++++ source/main/physics/flex/FlexFactory.h | 9 +++++++++ source/main/physics/flex/FlexMesh.h | 9 +++++++++ source/main/physics/flex/FlexMeshWheel.h | 9 +++++++++ source/main/physics/flex/FlexObj.h | 9 +++++++++ source/main/physics/flex/Flexable.h | 9 +++++++++ 42 files changed, 309 insertions(+), 2 deletions(-) diff --git a/source/main/gfx/DustPool.h b/source/main/gfx/DustPool.h index 7c07fe9f26..091513d4a6 100644 --- a/source/main/gfx/DustPool.h +++ b/source/main/gfx/DustPool.h @@ -27,6 +27,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + class DustPool : public ZeroedMemoryAllocator { public: @@ -84,4 +87,6 @@ class DustPool : public ZeroedMemoryAllocator bool m_is_discarded; }; +/// @} // addtogroup Gfx + } // namespace RoRs diff --git a/source/main/gfx/EnvironmentMap.h b/source/main/gfx/EnvironmentMap.h index 7202d6ef3f..64e1122267 100644 --- a/source/main/gfx/EnvironmentMap.h +++ b/source/main/gfx/EnvironmentMap.h @@ -26,6 +26,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + /// A dynamic environment probe; Creates a cubemap with realtime reflections around specified point. class GfxEnvmap { @@ -49,4 +52,6 @@ class GfxEnvmap int m_update_round; /// Render targets are updated one-by-one; this is the index of next target to update. }; +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/gfx/GfxActor.h b/source/main/gfx/GfxActor.h index 37c16f2606..d236dd887c 100644 --- a/source/main/gfx/GfxActor.h +++ b/source/main/gfx/GfxActor.h @@ -45,6 +45,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + class GfxActor { friend class ActorSpawner; // The factory @@ -331,4 +334,6 @@ class GfxActor Ogre::MaterialPtr m_cab_mat_template_emissive; }; +/// @} // addtogroup Gfx + } // Namespace RoR diff --git a/source/main/gfx/GfxData.h b/source/main/gfx/GfxData.h index 5f29be94a7..6fece34fb1 100644 --- a/source/main/gfx/GfxData.h +++ b/source/main/gfx/GfxData.h @@ -33,6 +33,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + enum PropAnimFlag { PROP_ANIM_FLAG_AIRSPEED = BITMASK(1), @@ -234,4 +237,6 @@ struct FlareMaterial // materialflares Ogre::ColourValue emissive_color; }; +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/gfx/GfxScene.h b/source/main/gfx/GfxScene.h index 33bfc59f6c..0e734de4e2 100644 --- a/source/main/gfx/GfxScene.h +++ b/source/main/gfx/GfxScene.h @@ -36,6 +36,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + /// Provides a 3D graphical representation of the simulation /// Idea: simulation runs at it's own constant rate, scene updates and rendering run asynchronously. class GfxScene @@ -93,4 +96,6 @@ class GfxScene SkidmarkConfig m_skidmark_conf; }; +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/gfx/HydraxWater.h b/source/main/gfx/HydraxWater.h index d49128a4a6..d411dd31bb 100644 --- a/source/main/gfx/HydraxWater.h +++ b/source/main/gfx/HydraxWater.h @@ -28,6 +28,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + class HydraxWater : public IWater { public: @@ -59,4 +62,6 @@ class HydraxWater : public IWater Ogre::String CurrentConfigFile; }; +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/gfx/IWater.h b/source/main/gfx/IWater.h index 2d6664662e..70e5f0ea4a 100644 --- a/source/main/gfx/IWater.h +++ b/source/main/gfx/IWater.h @@ -26,6 +26,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + class IWater //!< TODO: Mixed gfx+physics (waves) - must be separated ~ only_a_ptr, 02/2018 { public: @@ -57,4 +60,6 @@ class IWater //!< TODO: Mixed gfx+physics (waves) - must be separated ~ only_a_p virtual void ClearForcedCameraTransform() {}; }; +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/gfx/MovableText.h b/source/main/gfx/MovableText.h index 16c2d94ccb..0ecf3fcac5 100644 --- a/source/main/gfx/MovableText.h +++ b/source/main/gfx/MovableText.h @@ -33,6 +33,9 @@ #include namespace RoR { +/// @addtogroup Gfx +/// @{ + class MovableText : public Ogre::MovableObject, public Ogre::Renderable { /******************************** MovableText data ****************************/ @@ -127,5 +130,7 @@ class MovableText : public Ogre::MovableObject, public Ogre::Renderable const Ogre::LightList &getLights(void) const {return mLList;}; }; +/// @} // addtogroup Gfx + } // namespace diff --git a/source/main/gfx/Renderdash.h b/source/main/gfx/Renderdash.h index 4fb0855f9a..5378e24333 100644 --- a/source/main/gfx/Renderdash.h +++ b/source/main/gfx/Renderdash.h @@ -27,6 +27,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + /// 'renderdash' is a name of a classic Render-To-Texture animated material with gauges and other dashboard info. class Renderdash: public Ogre::RenderTargetListener { @@ -51,4 +54,6 @@ class Renderdash: public Ogre::RenderTargetListener Ogre::Overlay* m_needles_overlay; }; +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/gfx/ShadowManager.h b/source/main/gfx/ShadowManager.h index 1b3b946071..c1f6272bb6 100644 --- a/source/main/gfx/ShadowManager.h +++ b/source/main/gfx/ShadowManager.h @@ -35,6 +35,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + //Store datas using structs struct PSSM_Shadows_Data { @@ -68,4 +71,6 @@ class ShadowManager : public ZeroedMemoryAllocator PSSM_Shadows_Data PSSM_Shadows; }; +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/gfx/Skidmark.h b/source/main/gfx/Skidmark.h index 5ab6dec43a..8c72454183 100644 --- a/source/main/gfx/Skidmark.h +++ b/source/main/gfx/Skidmark.h @@ -52,6 +52,9 @@ class SkidmarkConfig //!< Skidmark config file parser and data container std::map> m_models; }; +/// @addtogroup Gfx +/// @{ + class Skidmark { public: @@ -97,4 +100,6 @@ class Skidmark SkidmarkConfig* m_config; }; +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/gfx/SkyManager.h b/source/main/gfx/SkyManager.h index e066fe418d..dbfb270f50 100644 --- a/source/main/gfx/SkyManager.h +++ b/source/main/gfx/SkyManager.h @@ -31,6 +31,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + class SkyManager : public ZeroedMemoryAllocator { public: @@ -55,6 +58,8 @@ class SkyManager : public ZeroedMemoryAllocator Caelum::CaelumSystem* m_caelum_system; }; +/// @} // addtogroup Gfx + } // namespace RoR #endif // USE_CAELUM diff --git a/source/main/gfx/SkyXManager.h b/source/main/gfx/SkyXManager.h index 7ca9f01cef..c6d8220653 100644 --- a/source/main/gfx/SkyXManager.h +++ b/source/main/gfx/SkyXManager.h @@ -26,6 +26,9 @@ along with Rigs of Rods. If not, see . namespace RoR { +/// @addtogroup Gfx +/// @{ + class SkyXManager : public ZeroedMemoryAllocator { public: @@ -64,4 +67,6 @@ class SkyXManager : public ZeroedMemoryAllocator int mLastHour = 0; }; -} // namespace RoRs +/// @} // addtogroup Gfx + +} // namespace RoR diff --git a/source/main/gfx/Water.h b/source/main/gfx/Water.h index 7b4a1bf21f..c981a08e6d 100644 --- a/source/main/gfx/Water.h +++ b/source/main/gfx/Water.h @@ -34,6 +34,9 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + class Water : public IWater, public ZeroedMemoryAllocator { public: @@ -136,4 +139,6 @@ class Water : public IWater, public ZeroedMemoryAllocator Ogre::Quaternion m_cam_forced_orientation; }; +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/gfx/hydrax/CfgFileManager.h b/source/main/gfx/hydrax/CfgFileManager.h index eb38929237..6a9371a002 100644 --- a/source/main/gfx/hydrax/CfgFileManager.h +++ b/source/main/gfx/hydrax/CfgFileManager.h @@ -29,6 +29,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Help.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { class Hydrax; @@ -209,4 +215,7 @@ namespace Hydrax }; }; +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif diff --git a/source/main/gfx/hydrax/DecalsManager.h b/source/main/gfx/hydrax/DecalsManager.h index 92b4b39df9..11b778c5b0 100644 --- a/source/main/gfx/hydrax/DecalsManager.h +++ b/source/main/gfx/hydrax/DecalsManager.h @@ -27,6 +27,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Prerequisites.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { class Hydrax; diff --git a/source/main/gfx/hydrax/Enums.h b/source/main/gfx/hydrax/Enums.h index 457c495380..d31c3fbee0 100644 --- a/source/main/gfx/hydrax/Enums.h +++ b/source/main/gfx/hydrax/Enums.h @@ -27,6 +27,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Prerequisites.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { /** Texture quality enumeration(2^n) diff --git a/source/main/gfx/hydrax/FFT.h b/source/main/gfx/hydrax/FFT.h index e8ebc885a0..7780d0134d 100644 --- a/source/main/gfx/hydrax/FFT.h +++ b/source/main/gfx/hydrax/FFT.h @@ -31,6 +31,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax{ namespace Noise { /** FFT noise module class diff --git a/source/main/gfx/hydrax/GPUNormalMapManager.h b/source/main/gfx/hydrax/GPUNormalMapManager.h index 5c60c843c1..1a458bb006 100644 --- a/source/main/gfx/hydrax/GPUNormalMapManager.h +++ b/source/main/gfx/hydrax/GPUNormalMapManager.h @@ -30,6 +30,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Enums.h" #include "RttManager.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { class Hydrax; @@ -152,4 +158,7 @@ namespace Hydrax }; } +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif \ No newline at end of file diff --git a/source/main/gfx/hydrax/GodRaysManager.h b/source/main/gfx/hydrax/GodRaysManager.h index e73c89bf2b..7e6f614ac1 100644 --- a/source/main/gfx/hydrax/GodRaysManager.h +++ b/source/main/gfx/hydrax/GodRaysManager.h @@ -30,6 +30,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Enums.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { class Hydrax; diff --git a/source/main/gfx/hydrax/Help.h b/source/main/gfx/hydrax/Help.h index 0ad1839257..d358d15899 100644 --- a/source/main/gfx/hydrax/Help.h +++ b/source/main/gfx/hydrax/Help.h @@ -27,6 +27,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Prerequisites.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { /** Struct wich contains an especific width and height value @@ -115,4 +121,7 @@ namespace Hydrax }; } +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif diff --git a/source/main/gfx/hydrax/Hydrax.h b/source/main/gfx/hydrax/Hydrax.h index 9e289a0c75..38176e2946 100644 --- a/source/main/gfx/hydrax/Hydrax.h +++ b/source/main/gfx/hydrax/Hydrax.h @@ -41,6 +41,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "CfgFileManager.h" #include "Module.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { /** Main Hydrax class. @@ -756,4 +762,7 @@ namespace Hydrax }; } +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif diff --git a/source/main/gfx/hydrax/Image.h b/source/main/gfx/hydrax/Image.h index 129dc50c32..1a326e0bc5 100644 --- a/source/main/gfx/hydrax/Image.h +++ b/source/main/gfx/hydrax/Image.h @@ -27,7 +27,11 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Prerequisites.h" -#include "Help.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ namespace Hydrax { @@ -265,4 +269,7 @@ namespace Hydrax }; } +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif \ No newline at end of file diff --git a/source/main/gfx/hydrax/MaterialManager.h b/source/main/gfx/hydrax/MaterialManager.h index 3f24b1c424..3ed98e272f 100644 --- a/source/main/gfx/hydrax/MaterialManager.h +++ b/source/main/gfx/hydrax/MaterialManager.h @@ -29,6 +29,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Enums.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { class Hydrax; @@ -377,4 +383,7 @@ namespace Hydrax }; }; +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif \ No newline at end of file diff --git a/source/main/gfx/hydrax/Mesh.h b/source/main/gfx/hydrax/Mesh.h index 5b95560f0f..e8834e926d 100644 --- a/source/main/gfx/hydrax/Mesh.h +++ b/source/main/gfx/hydrax/Mesh.h @@ -30,6 +30,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Help.h" #include "Image.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { class Hydrax; @@ -333,4 +339,7 @@ namespace Hydrax }; } +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif diff --git a/source/main/gfx/hydrax/Module.h b/source/main/gfx/hydrax/Module.h index 601514f3db..d4064b26b3 100644 --- a/source/main/gfx/hydrax/Module.h +++ b/source/main/gfx/hydrax/Module.h @@ -32,6 +32,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "MaterialManager.h" #include "GPUNormalMapManager.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax{ namespace Module { /** Base module class, @@ -158,4 +164,7 @@ namespace Hydrax{ namespace Module }; }} +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif \ No newline at end of file diff --git a/source/main/gfx/hydrax/Noise.h b/source/main/gfx/hydrax/Noise.h index 73988a21e5..75f25a785c 100644 --- a/source/main/gfx/hydrax/Noise.h +++ b/source/main/gfx/hydrax/Noise.h @@ -28,6 +28,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Prerequisites.h" #include "GPUNormalMapManager.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax{ namespace Noise { /** Base noise class, @@ -133,4 +139,7 @@ namespace Hydrax{ namespace Noise }; }} +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif \ No newline at end of file diff --git a/source/main/gfx/hydrax/Perlin.h b/source/main/gfx/hydrax/Perlin.h index 90a6d532c7..d6478589f2 100644 --- a/source/main/gfx/hydrax/Perlin.h +++ b/source/main/gfx/hydrax/Perlin.h @@ -31,6 +31,12 @@ Based on the perlin noise code from Claes Johanson thesis: #include "Noise.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + #define n_bits 5 #define n_size (1<<(n_bits-1)) #define n_size_m1 (n_size - 1) @@ -278,4 +284,7 @@ namespace Hydrax{ namespace Noise }; }} +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif diff --git a/source/main/gfx/hydrax/PressurePoint.h b/source/main/gfx/hydrax/PressurePoint.h index c1215ac176..eb332a3ea9 100644 --- a/source/main/gfx/hydrax/PressurePoint.h +++ b/source/main/gfx/hydrax/PressurePoint.h @@ -51,6 +51,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #define _HydraxGravity_ 9.81 #endif +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax{ namespace Noise { @@ -149,4 +155,7 @@ class PressurePoint }} // Namespace +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif // PRESSUREPOINT_H_INCLUDED diff --git a/source/main/gfx/hydrax/ProjectedGrid.h b/source/main/gfx/hydrax/ProjectedGrid.h index 562baf7e38..ce7c93cc34 100644 --- a/source/main/gfx/hydrax/ProjectedGrid.h +++ b/source/main/gfx/hydrax/ProjectedGrid.h @@ -37,6 +37,12 @@ and Ren Cheng Ogre3D implementation: #include "Mesh.h" #include "Module.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax{ namespace Module { /** Hydrax projected grid module @@ -275,4 +281,7 @@ namespace Hydrax{ namespace Module }; }} +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif \ No newline at end of file diff --git a/source/main/gfx/hydrax/RadialGrid.h b/source/main/gfx/hydrax/RadialGrid.h index 14db4e30ac..8adaa61b1e 100644 --- a/source/main/gfx/hydrax/RadialGrid.h +++ b/source/main/gfx/hydrax/RadialGrid.h @@ -31,6 +31,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Mesh.h" #include "Module.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax{ namespace Module { /** Hydrax radial grid module @@ -227,4 +233,7 @@ namespace Hydrax{ namespace Module }; }} +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif \ No newline at end of file diff --git a/source/main/gfx/hydrax/Real.h b/source/main/gfx/hydrax/Real.h index 087dab54a0..fb603cb7fc 100644 --- a/source/main/gfx/hydrax/Real.h +++ b/source/main/gfx/hydrax/Real.h @@ -50,6 +50,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Wave.h" #include "PressurePoint.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax{ namespace Noise { @@ -180,6 +186,8 @@ class Real : public Noise std::vector mPressurePoints; }; +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx }} // Namespace diff --git a/source/main/gfx/hydrax/RttManager.h b/source/main/gfx/hydrax/RttManager.h index 1bab78ced6..309c816879 100644 --- a/source/main/gfx/hydrax/RttManager.h +++ b/source/main/gfx/hydrax/RttManager.h @@ -30,6 +30,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Enums.h" #include "Help.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { class Hydrax; @@ -513,4 +519,7 @@ namespace Hydrax }; }; +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif diff --git a/source/main/gfx/hydrax/SimpleGrid.h b/source/main/gfx/hydrax/SimpleGrid.h index 7048ab99a7..6786fee051 100644 --- a/source/main/gfx/hydrax/SimpleGrid.h +++ b/source/main/gfx/hydrax/SimpleGrid.h @@ -31,6 +31,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Mesh.h" #include "Module.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax{ namespace Module { /** Hydrax simple grid module @@ -191,4 +197,7 @@ namespace Hydrax{ namespace Module }; }} +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif \ No newline at end of file diff --git a/source/main/gfx/hydrax/TextureManager.h b/source/main/gfx/hydrax/TextureManager.h index 47d58dab58..15bf836e38 100644 --- a/source/main/gfx/hydrax/TextureManager.h +++ b/source/main/gfx/hydrax/TextureManager.h @@ -30,6 +30,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to #include "Enums.h" #include "Image.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax { class Hydrax; @@ -136,4 +142,7 @@ namespace Hydrax }; } +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + #endif \ No newline at end of file diff --git a/source/main/gfx/hydrax/Wave.h b/source/main/gfx/hydrax/Wave.h index 3ffa4b84cb..fc6163596a 100644 --- a/source/main/gfx/hydrax/Wave.h +++ b/source/main/gfx/hydrax/Wave.h @@ -44,6 +44,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to // ---------------------------------------------------------------------------- #include "Perlin.h" +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Hydrax +/// @{ + namespace Hydrax{ namespace Noise { @@ -128,6 +134,9 @@ class Wave float mK; }; +/// @} // addtogroup Hydrax +/// @} // addtogroup Gfx + }} // Namespace #endif // WAVE_H_INCLUDED diff --git a/source/main/physics/flex/FlexBody.h b/source/main/physics/flex/FlexBody.h index 4266a1aadc..69f8c4a52b 100644 --- a/source/main/physics/flex/FlexBody.h +++ b/source/main/physics/flex/FlexBody.h @@ -31,6 +31,12 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Flex +/// @{ + /// Flexbody = A deformable mesh; updated on CPU every frame, then uploaded to video memory class FlexBody { @@ -109,4 +115,7 @@ class FlexBody bool m_blend_changed; }; +/// @} // addtogroup Flex +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/physics/flex/FlexFactory.h b/source/main/physics/flex/FlexFactory.h index c70ee720c7..d65fb839eb 100644 --- a/source/main/physics/flex/FlexFactory.h +++ b/source/main/physics/flex/FlexFactory.h @@ -39,6 +39,12 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Flex +/// @{ + struct FlexBodyRecordHeader { FlexBodyRecordHeader(): @@ -198,4 +204,7 @@ class FlexFactory unsigned int m_flexbody_cache_next_index; }; +/// @} // addtogroup Flex +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/physics/flex/FlexMesh.h b/source/main/physics/flex/FlexMesh.h index d96ff6c285..7f100c9cbe 100644 --- a/source/main/physics/flex/FlexMesh.h +++ b/source/main/physics/flex/FlexMesh.h @@ -34,6 +34,12 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Flex +/// @{ + class FlexMesh: public Flexable { public: @@ -93,4 +99,7 @@ class FlexMesh: public Flexable unsigned short* m_tiretread_indices; }; +/// @} // addtogroup Flex +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/physics/flex/FlexMeshWheel.h b/source/main/physics/flex/FlexMeshWheel.h index f235d8e43b..1b915747ae 100644 --- a/source/main/physics/flex/FlexMeshWheel.h +++ b/source/main/physics/flex/FlexMeshWheel.h @@ -29,6 +29,12 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Flex +/// @{ + /// Consists of static mesh, representing the rim, and dynamic mesh, representing the tire. class FlexMeshWheel: public Flexable { @@ -101,4 +107,7 @@ class FlexMeshWheel: public Flexable unsigned short* m_indices; }; +/// @} // addtogroup Flex +/// @} // addtogroup Gfx + } // namespace RoR diff --git a/source/main/physics/flex/FlexObj.h b/source/main/physics/flex/FlexObj.h index 3418f02e10..069d076e34 100644 --- a/source/main/physics/flex/FlexObj.h +++ b/source/main/physics/flex/FlexObj.h @@ -28,6 +28,12 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Flex +/// @{ + /// Texture coordinates for old-style actor body (the "cab") struct CabTexcoord { @@ -104,4 +110,7 @@ class FlexObj : public ZeroedMemoryAllocator int m_triangle_count; }; +/// @} // addtogroup Flex +/// @} // addtogroup Gfx + } // namespace RoRs diff --git a/source/main/physics/flex/Flexable.h b/source/main/physics/flex/Flexable.h index c50110d4a0..729e821347 100644 --- a/source/main/physics/flex/Flexable.h +++ b/source/main/physics/flex/Flexable.h @@ -24,6 +24,12 @@ namespace RoR { +/// @addtogroup Gfx +/// @{ + +/// @addtogroup Flex +/// @{ + // NOTE: class FlexBody no longer uses this interface ~ only_a_ptr, 05/2018 class Flexable { @@ -37,4 +43,7 @@ class Flexable virtual void setVisible(bool visible) = 0; }; +/// @} // addtogroup Flex +/// @} // addtogroup Gfx + } // namespace RoR