📚 Doxygen: + modules Gfx, Hydrax, Flex

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

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

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

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

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

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

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

source/main/gfx/MovableText.h

@@ -33,6 +33,9 @@
 #include <OgreUTFString.h>
 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
 

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

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

source/main/gfx/Skidmark.h

@@ -52,6 +52,9 @@ class SkidmarkConfig //!< Skidmark config file parser and data container
     std::map<Ogre::String, std::vector<SkidmarkDef>> m_models;
 };
 
+/// @addtogroup Gfx
+/// @{
+
 class Skidmark
 {
 public:
@@ -97,4 +100,6 @@ class Skidmark
     SkidmarkConfig*      m_config;
 };
 
+/// @} // addtogroup Gfx
+
 } // namespace RoR

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

source/main/gfx/SkyXManager.h

@@ -26,6 +26,9 @@ along with Rigs of Rods.  If not, see <http://www.gnu.org/licenses/>.
 
 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

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

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

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;

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)

source/main/gfx/hydrax/FFT.h

@@ -31,6 +31,12 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to
 
 #include <complex>
 
+/// @addtogroup Gfx
+/// @{
+
+/// @addtogroup Hydrax
+/// @{
+
 namespace Hydrax{ namespace Noise
 {
 	/** FFT noise module class

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

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;

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

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