a little documentation never hurt anyone

lib/Ray/sources/Audio/IAudio.hpp

@@ -13,6 +13,7 @@
 
 namespace RAY::Audio
 {
+	//! @brief Interface for Audio ressources
 	class IAudio: public IRessource {
 		public:
 			virtual ~IAudio() = 0;

lib/Ray/sources/Audio/Music.hpp

@@ -15,6 +15,7 @@
 
 namespace RAY::Audio
 {
+	//! @brief A manager for music stream
 	class Music: public IAudio {
 		public:
 

lib/Ray/sources/Audio/Sound.hpp

@@ -15,6 +15,7 @@
 
 namespace RAY::Audio
 {
+	//! @brief A manager for sound stream
 	class Sound: public IAudio {
 		public:
 

lib/Ray/sources/Camera/ICamera.hpp

@@ -11,6 +11,7 @@
 #include "Matrix.hpp"
 
 namespace RAY::Camera {
+	//! @brief Interface for Cameras
 	class ICamera {
 		public:
 			virtual ~ICamera() = default;

lib/Ray/sources/Canvas.hpp

@@ -12,6 +12,7 @@ namespace RAY {
 	namespace Drawables {
 		class IDrawable;
 	}
+	//! @brief Interface for any drawable surface
 	class Canvas {
 		public:
 			//! @brief A default destructor

lib/Ray/sources/Color.hpp

@@ -11,6 +11,7 @@
 #include <raylib.h>
 
 namespace RAY {
+	//! @brief Object representation of color
 	class Color {
 		public:
 			//! @brief A Color constructor

lib/Ray/sources/Controllers/Gamepad.hpp

@@ -11,8 +11,7 @@
 #include <raylib.h>
 #include <vector>
 
-namespace RAY
+namespace RAY::Controller {
-::Controller {
 
 	//! @brief Entity representing a gamepad controller
 	class GamePad {

lib/Ray/sources/Controllers/Keyboard.hpp

@@ -13,6 +13,7 @@
 #include <vector>
 
 namespace RAY::Controller {
+	//! @brief Keyboard event manager
 	class Keyboard {
 		public:
 			typedef ::KeyboardKey Key;

lib/Ray/sources/Controllers/Mouse.hpp

@@ -13,6 +13,7 @@
 #include <vector>
 
 namespace RAY::Controller {
+	//! @brief Mouse event manager
 	class Mouse {
 		public:
 			typedef ::MouseButton Button;

lib/Ray/sources/Drawables/2D/Circle.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable2D.hpp"
 
 namespace RAY::Drawables::Drawables2D {
+	//! @brief Circle in a two-dimensionnal space
 	class Circle: public ADrawable2D
 	{
 		public:

lib/Ray/sources/Drawables/2D/Line.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable2D.hpp"
 
 namespace RAY::Drawables::Drawables2D {
+	//! @brief Line in a two-dimensionnal space
 	class Line: public ADrawable2D
 	{
 		public:

lib/Ray/sources/Drawables/2D/Point.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable2D.hpp"
 
 namespace RAY::Drawables::Drawables2D {
+	//! @brief Point in a two-dimensionnal space
 	class Point: public ADrawable2D
 	{
 		public:

lib/Ray/sources/Drawables/2D/Rectangle.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable2D.hpp"
 
 namespace RAY::Drawables::Drawables2D {
+	//! @brief Rectangle in a two-dimensionnal space
 	class Rectangle: public ADrawable2D
 	{
 		public:

lib/Ray/sources/Drawables/2D/Text.hpp

@@ -14,6 +14,7 @@
 #define DEFAULT_LETTER_SPACING 1
 
 namespace RAY::Drawables::Drawables2D {
+	//! @brief Text in a two-dimensionnal space
 	class Text: public ADrawable2D
 	{
 		public:

lib/Ray/sources/Drawables/2D/Triangle.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable2D.hpp"
 
 namespace RAY::Drawables::Drawables2D {
+	//! @brief Triangle in a two-dimensionnal space
 	class Triangle: public ADrawable2D
 	{
 		public:

lib/Ray/sources/Drawables/3D/Circle.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable3D.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Circle in a three-dimensionnal space
 	class Circle: public ADrawable3D
 	{
 		public:

lib/Ray/sources/Drawables/3D/Cube.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable3D.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Cube in a three-dimensionnal space
 	class Cube: public ADrawable3D
 	{
 		public:

lib/Ray/sources/Drawables/3D/Cylinder.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable3D.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Cylinder in a three-dimensionnal space
 	class Cylinder: public ADrawable3D
 	{
 		public:

lib/Ray/sources/Drawables/3D/Line.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable3D.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Line in a three-dimensionnal space
 	class Line: public ADrawable3D
 	{
 		public:

lib/Ray/sources/Drawables/3D/Plane.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable3D.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Plane in a three-dimensionnal space
 	class Plane: public ADrawable3D
 	{
 		public:

lib/Ray/sources/Drawables/3D/Point.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable3D.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Point in a three-dimensionnal space
 	class Point: public ADrawable3D
 	{
 		public:

lib/Ray/sources/Drawables/3D/Ray.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable3D.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Ray in a three-dimensionnal space
 	class Ray: public ADrawable3D
 	{
 		public:

lib/Ray/sources/Drawables/3D/Sphere.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable3D.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Sphere in a three-dimensionnal space
 	class Sphere: public ADrawable3D
 	{
 		public:

lib/Ray/sources/Drawables/3D/Triangle.hpp

@@ -12,6 +12,7 @@
 #include "Drawables/ADrawable3D.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Triangle in a three-dimensionnal space
 	class Triangle: public ADrawable3D
 	{
 		public:

lib/Ray/sources/Drawables/ADrawable2D.hpp

@@ -14,6 +14,7 @@
 #include "Color.hpp"
 
 namespace RAY::Drawables::Drawables2D {
+	//! @brief Abstraction of any two-dimensionnal drawable
 	class ADrawable2D: public IDrawable
 	{
 		public:

lib/Ray/sources/Drawables/ADrawable3D.hpp

@@ -14,6 +14,7 @@
 #include "Color.hpp"
 
 namespace RAY::Drawables::Drawables3D {
+	//! @brief Abstraction of any three-dimensionnal drawable
 	class ADrawable3D: public IDrawable
 	{
 		public:

lib/Ray/sources/Drawables/IDrawable.hpp

@@ -16,6 +16,7 @@ namespace RAY
 	class Window;
 	class Image;
 	namespace Drawables {
+		//! @brief Interface for any drawable
 		class IDrawable {
 			public:
 				virtual ~IDrawable() = default;

lib/Ray/sources/Drawables/Image.hpp

@@ -20,6 +20,7 @@ namespace RAY
 		class ADrawable2D;
 	}
 	class IRessource;
+	//! @brief Object representation of a framebuffer
 	class Image: public Canvas, public IRessource {
 		public:
 			//! @brief Create an image, loading a file

lib/Ray/sources/Drawables/Texture.hpp

@@ -15,6 +15,7 @@
 
 namespace RAY
 {
+	//! @brief Object representation of a texture
 	class Texture: public IRessource {
 		public:
 			//! @brief Create an texture, loading a file

lib/Ray/sources/Font.hpp

@@ -13,6 +13,7 @@
 
 namespace RAY
 {
+	//! @brief A font manager
 	class Font: public IRessource {
 		public:
 			//! @brief Create an font, loading a file

lib/Ray/sources/IRessource.hpp

@@ -11,6 +11,7 @@
 #include <string>
 
 namespace RAY {
+	//! @brief A Ressource interface
 	class IRessource {
 		public:
 			virtual ~IRessource() = default;

lib/Ray/sources/Vector/Vector2.hpp

@@ -11,7 +11,7 @@
 #include <raylib.h>
 
 namespace RAY {
-	//! @brief A Two-diemnsionnal Vector data type.
+	//! @brief A Two-dimensionnal Vector data type.
 	struct Vector2
 	{
 		//! @brief Vector 2 constructor

lib/Ray/sources/Window.hpp

@@ -20,6 +20,7 @@
 #include "Drawables/Texture.hpp"
 
 namespace RAY {
+	//! @brief Window manager
 	class Window: public Canvas {
 		public:
 			//! @return A widow insta,ce. Only one window can be open at a time