From 8ca3ebcdc4c05e1cfd51ec4ba666dea26b64c3f9 Mon Sep 17 00:00:00 2001 From: "arthur.jamet" Date: Sat, 22 May 2021 01:14:21 +0200 Subject: [PATCH] a little documentation never hurt anyone --- lib/Ray/sources/Audio/IAudio.hpp | 1 + lib/Ray/sources/Audio/Music.hpp | 1 + lib/Ray/sources/Audio/Sound.hpp | 1 + lib/Ray/sources/Camera/ICamera.hpp | 1 + lib/Ray/sources/Canvas.hpp | 1 + lib/Ray/sources/Color.hpp | 1 + lib/Ray/sources/Controllers/Gamepad.hpp | 3 +-- lib/Ray/sources/Controllers/Keyboard.hpp | 1 + lib/Ray/sources/Controllers/Mouse.hpp | 1 + lib/Ray/sources/Drawables/2D/Circle.hpp | 1 + lib/Ray/sources/Drawables/2D/Line.hpp | 1 + lib/Ray/sources/Drawables/2D/Point.hpp | 1 + lib/Ray/sources/Drawables/2D/Rectangle.hpp | 1 + lib/Ray/sources/Drawables/2D/Text.hpp | 1 + lib/Ray/sources/Drawables/2D/Triangle.hpp | 1 + lib/Ray/sources/Drawables/3D/Circle.hpp | 1 + lib/Ray/sources/Drawables/3D/Cube.hpp | 1 + lib/Ray/sources/Drawables/3D/Cylinder.hpp | 1 + lib/Ray/sources/Drawables/3D/Line.hpp | 1 + lib/Ray/sources/Drawables/3D/Plane.hpp | 1 + lib/Ray/sources/Drawables/3D/Point.hpp | 1 + lib/Ray/sources/Drawables/3D/Ray.hpp | 1 + lib/Ray/sources/Drawables/3D/Sphere.hpp | 1 + lib/Ray/sources/Drawables/3D/Triangle.hpp | 1 + lib/Ray/sources/Drawables/ADrawable2D.hpp | 1 + lib/Ray/sources/Drawables/ADrawable3D.hpp | 1 + lib/Ray/sources/Drawables/IDrawable.hpp | 1 + lib/Ray/sources/Drawables/Image.hpp | 1 + lib/Ray/sources/Drawables/Texture.hpp | 1 + lib/Ray/sources/Font.hpp | 1 + lib/Ray/sources/IRessource.hpp | 1 + lib/Ray/sources/Vector/Vector2.hpp | 2 +- lib/Ray/sources/Window.hpp | 1 + 33 files changed, 33 insertions(+), 3 deletions(-) diff --git a/lib/Ray/sources/Audio/IAudio.hpp b/lib/Ray/sources/Audio/IAudio.hpp index 8681e5e2..82dc1606 100644 --- a/lib/Ray/sources/Audio/IAudio.hpp +++ b/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; diff --git a/lib/Ray/sources/Audio/Music.hpp b/lib/Ray/sources/Audio/Music.hpp index 9e4c58ae..46942597 100644 --- a/lib/Ray/sources/Audio/Music.hpp +++ b/lib/Ray/sources/Audio/Music.hpp @@ -15,6 +15,7 @@ namespace RAY::Audio { + //! @brief A manager for music stream class Music: public IAudio { public: diff --git a/lib/Ray/sources/Audio/Sound.hpp b/lib/Ray/sources/Audio/Sound.hpp index d3127c7f..4ceb29d0 100644 --- a/lib/Ray/sources/Audio/Sound.hpp +++ b/lib/Ray/sources/Audio/Sound.hpp @@ -15,6 +15,7 @@ namespace RAY::Audio { + //! @brief A manager for sound stream class Sound: public IAudio { public: diff --git a/lib/Ray/sources/Camera/ICamera.hpp b/lib/Ray/sources/Camera/ICamera.hpp index 50cb2624..33c46c21 100644 --- a/lib/Ray/sources/Camera/ICamera.hpp +++ b/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; diff --git a/lib/Ray/sources/Canvas.hpp b/lib/Ray/sources/Canvas.hpp index 94aade72..549a5707 100644 --- a/lib/Ray/sources/Canvas.hpp +++ b/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 diff --git a/lib/Ray/sources/Color.hpp b/lib/Ray/sources/Color.hpp index 7c29cf19..0ad89a87 100644 --- a/lib/Ray/sources/Color.hpp +++ b/lib/Ray/sources/Color.hpp @@ -11,6 +11,7 @@ #include namespace RAY { + //! @brief Object representation of color class Color { public: //! @brief A Color constructor diff --git a/lib/Ray/sources/Controllers/Gamepad.hpp b/lib/Ray/sources/Controllers/Gamepad.hpp index 77c7da9f..893c674f 100644 --- a/lib/Ray/sources/Controllers/Gamepad.hpp +++ b/lib/Ray/sources/Controllers/Gamepad.hpp @@ -11,8 +11,7 @@ #include #include -namespace RAY -::Controller { +namespace RAY::Controller { //! @brief Entity representing a gamepad controller class GamePad { diff --git a/lib/Ray/sources/Controllers/Keyboard.hpp b/lib/Ray/sources/Controllers/Keyboard.hpp index 713c8e83..be5c54d2 100644 --- a/lib/Ray/sources/Controllers/Keyboard.hpp +++ b/lib/Ray/sources/Controllers/Keyboard.hpp @@ -13,6 +13,7 @@ #include namespace RAY::Controller { + //! @brief Keyboard event manager class Keyboard { public: typedef ::KeyboardKey Key; diff --git a/lib/Ray/sources/Controllers/Mouse.hpp b/lib/Ray/sources/Controllers/Mouse.hpp index e0be9657..e42a38a4 100644 --- a/lib/Ray/sources/Controllers/Mouse.hpp +++ b/lib/Ray/sources/Controllers/Mouse.hpp @@ -13,6 +13,7 @@ #include namespace RAY::Controller { + //! @brief Mouse event manager class Mouse { public: typedef ::MouseButton Button; diff --git a/lib/Ray/sources/Drawables/2D/Circle.hpp b/lib/Ray/sources/Drawables/2D/Circle.hpp index a0335ff3..80824f7e 100644 --- a/lib/Ray/sources/Drawables/2D/Circle.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/2D/Line.hpp b/lib/Ray/sources/Drawables/2D/Line.hpp index 4597fef6..31afbc53 100644 --- a/lib/Ray/sources/Drawables/2D/Line.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/2D/Point.hpp b/lib/Ray/sources/Drawables/2D/Point.hpp index a937ccdc..641aa9d3 100644 --- a/lib/Ray/sources/Drawables/2D/Point.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/2D/Rectangle.hpp b/lib/Ray/sources/Drawables/2D/Rectangle.hpp index 3dc4b93f..79f9dabb 100644 --- a/lib/Ray/sources/Drawables/2D/Rectangle.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/2D/Text.hpp b/lib/Ray/sources/Drawables/2D/Text.hpp index dfe2e5bc..e1fb8ca0 100644 --- a/lib/Ray/sources/Drawables/2D/Text.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/2D/Triangle.hpp b/lib/Ray/sources/Drawables/2D/Triangle.hpp index da546d10..61a71615 100644 --- a/lib/Ray/sources/Drawables/2D/Triangle.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/3D/Circle.hpp b/lib/Ray/sources/Drawables/3D/Circle.hpp index 343726a4..6c014e9c 100644 --- a/lib/Ray/sources/Drawables/3D/Circle.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/3D/Cube.hpp b/lib/Ray/sources/Drawables/3D/Cube.hpp index 1e336b88..c9972f04 100644 --- a/lib/Ray/sources/Drawables/3D/Cube.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/3D/Cylinder.hpp b/lib/Ray/sources/Drawables/3D/Cylinder.hpp index 45c80922..91ca8ed2 100644 --- a/lib/Ray/sources/Drawables/3D/Cylinder.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/3D/Line.hpp b/lib/Ray/sources/Drawables/3D/Line.hpp index 08630ace..03148618 100644 --- a/lib/Ray/sources/Drawables/3D/Line.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/3D/Plane.hpp b/lib/Ray/sources/Drawables/3D/Plane.hpp index 25d2f474..a4f6dc71 100644 --- a/lib/Ray/sources/Drawables/3D/Plane.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/3D/Point.hpp b/lib/Ray/sources/Drawables/3D/Point.hpp index 526458a2..03af0e98 100644 --- a/lib/Ray/sources/Drawables/3D/Point.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/3D/Ray.hpp b/lib/Ray/sources/Drawables/3D/Ray.hpp index 5eff0895..8895c342 100644 --- a/lib/Ray/sources/Drawables/3D/Ray.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/3D/Sphere.hpp b/lib/Ray/sources/Drawables/3D/Sphere.hpp index b18d92b0..4e1095f6 100644 --- a/lib/Ray/sources/Drawables/3D/Sphere.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/3D/Triangle.hpp b/lib/Ray/sources/Drawables/3D/Triangle.hpp index 414ebaea..bee8b049 100644 --- a/lib/Ray/sources/Drawables/3D/Triangle.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/ADrawable2D.hpp b/lib/Ray/sources/Drawables/ADrawable2D.hpp index fb8a8145..11108da2 100644 --- a/lib/Ray/sources/Drawables/ADrawable2D.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/ADrawable3D.hpp b/lib/Ray/sources/Drawables/ADrawable3D.hpp index 576e842b..3bb3127f 100644 --- a/lib/Ray/sources/Drawables/ADrawable3D.hpp +++ b/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: diff --git a/lib/Ray/sources/Drawables/IDrawable.hpp b/lib/Ray/sources/Drawables/IDrawable.hpp index c24e0cdd..97c0a110 100644 --- a/lib/Ray/sources/Drawables/IDrawable.hpp +++ b/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; diff --git a/lib/Ray/sources/Drawables/Image.hpp b/lib/Ray/sources/Drawables/Image.hpp index 4472106f..c9f8577d 100644 --- a/lib/Ray/sources/Drawables/Image.hpp +++ b/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 diff --git a/lib/Ray/sources/Drawables/Texture.hpp b/lib/Ray/sources/Drawables/Texture.hpp index 8a782c90..bab0c36f 100644 --- a/lib/Ray/sources/Drawables/Texture.hpp +++ b/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 diff --git a/lib/Ray/sources/Font.hpp b/lib/Ray/sources/Font.hpp index ed97109e..5b467e96 100644 --- a/lib/Ray/sources/Font.hpp +++ b/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 diff --git a/lib/Ray/sources/IRessource.hpp b/lib/Ray/sources/IRessource.hpp index 3126394e..2482cc3c 100644 --- a/lib/Ray/sources/IRessource.hpp +++ b/lib/Ray/sources/IRessource.hpp @@ -11,6 +11,7 @@ #include namespace RAY { + //! @brief A Ressource interface class IRessource { public: virtual ~IRessource() = default; diff --git a/lib/Ray/sources/Vector/Vector2.hpp b/lib/Ray/sources/Vector/Vector2.hpp index b747c245..e384b020 100644 --- a/lib/Ray/sources/Vector/Vector2.hpp +++ b/lib/Ray/sources/Vector/Vector2.hpp @@ -11,7 +11,7 @@ #include namespace RAY { - //! @brief A Two-diemnsionnal Vector data type. + //! @brief A Two-dimensionnal Vector data type. struct Vector2 { //! @brief Vector 2 constructor diff --git a/lib/Ray/sources/Window.hpp b/lib/Ray/sources/Window.hpp index 3bf025c2..ccafda43 100644 --- a/lib/Ray/sources/Window.hpp +++ b/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