Updated docs and some Doxygen fixes

1 files changed, 21 insertions, 18 deletions

diff --git a/src/graphics/engine/lightman.h b/src/graphics/engine/lightman.h
index 3b96e51..d83dfb3 100644
--- a/src/graphics/engine/lightman.h
+++ b/src/graphics/engine/lightman.h
@@ -34,8 +34,9 @@
 namespace Gfx {
 
 /**
-  \struct LightProgression
-  \brief Describes the progression of light parameters change */
+ * \struct LightProgression
+ * \brief Describes the progression of light parameters change
+ */
 struct LightProgression
 {
     //! Starting value
@@ -75,11 +76,12 @@ enum LightPriority
 };
 
 /**
-  \struct DynamicLight
-  \brief Dynamic light in 3D scene
-
-  It is an extension over standard light properties. Added are dynamic progressions for light
-  colors and intensity and types of objects included/excluded in lighting. */
+ * \struct DynamicLight
+ * \brief Dynamic light in 3D scene
+ *
+ * It is an extension over standard light properties. Added are dynamic progressions for light
+ * colors and intensity and types of objects included/excluded in lighting.
+ */
 struct DynamicLight
 {
     //! Whether the light is used
@@ -111,17 +113,18 @@ struct DynamicLight
 };
 
 /**
-  \class CLightManager
-  \brief Manager for dynamic lights in 3D scene
-
-  (Old CLight class)
-
-  The class is responsible for managing dynamic lights (struct DynamicLight) used in 3D scene.
-  The dynamic lights are created, updated and deleted through the class' interface.
-
-  Number of available lights depends on graphics device used. Class allocates vector
-  for the total number of lights, but only some are used.
-  */
+ * \class CLightManager
+ * \brief Manager for dynamic lights in 3D scene
+ *
+ * The class is responsible for managing dynamic lights (struct DynamicLight) used in 3D scene.
+ * The dynamic lights are created, updated and deleted through the class' interface.
+ *
+ * Since there is a limit on total number of lights available in OpenGL (usually up to 8), the dynamic lights
+ * must be emulated by displaying only some of them. All functions normally operate only on DynamicLight structs,
+ * updating the models with new values, while only one function, UpdateDeviceLights(), performs the actual
+ * synchronization to the device. It allocates device's light slots as necessary, with two priority levels
+ * for lights.
+ */
 class CLightManager
 {
 public: