Outline of Documentation work

include/JGL/JGL.h

@@ -54,6 +54,7 @@ namespace JGL {
         /// Provide a list of lights to be used in 2D space. Typically directly after J2D::Begin();
         /// 8 lights maximum for now. Some kind of light sorting will eventually be needed per j2d element.
         void LightArray(Light*, size_t size);
+        void LightArray(std::vector<Light> lights);
 
         /// Plots a single pixel on the screen.
         /// @param color  A 3-or-4 channel color value. @see class Color3, class Color4
@@ -133,16 +134,28 @@ namespace JGL {
         void FillRoundedRect(const Color4& color, const Vector2& pos, const Vector2& size, float radius = 5, unsigned int subdivisions = 8);
 
         /// Draws a filled rectangle with chamfered (beveled) corners on the screen.
+        /// @param color
+        /// @param pos
+        /// @param size
+        /// @param radius
         void FillChamferRect(const Color4& color, const Vector2& pos, const Vector2& size, float radius = 5);
 
 
-
-        /// Draws a render target to the screen.
         void DrawRenderTarget(const RenderTarget& render_target, const Vector2& position, float rad_rotation = 0, const Vector2& origin = Vector2(0 , 0),
                               const Vector2& scale = Vector2(1, 1), const Color4& color = Colors::White, Direction inversion = Direction::None);
         void DrawRenderTarget(const RenderTarget* render_target, const Vector2& position, float rad_rotation = 0, const Vector2& origin = Vector2(0 , 0),
                               const Vector2& scale = Vector2(1, 1), const Color4& color = Colors::White, Direction inversion = Direction::None);
-        void DrawSprite(const RenderTarget& render_target,const Vector2& position, float rad_rotation = 0, const Vector2& origin = Vector2(0 , 0),
+
+
+        /// Draws a render target to the screen.
+        /// @param render_target
+        /// @param position
+        /// @param rad_rotation
+        /// @param origin
+        /// @param scale
+        /// @param color
+        /// @param inversion
+        void DrawSprite(const RenderTarget& render_target, const Vector2& position, float rad_rotation = 0, const Vector2& origin = Vector2(0 , 0),
                 const Vector2& scale = Vector2(1, 1), const Color4& color = Colors::White, Direction inversion = Direction::None);
         void DrawSprite(const RenderTarget* render_target, const Vector2& position, float rad_rotation = 0, const Vector2& origin = Vector2(0 , 0),
                         const Vector2& scale = Vector2(1, 1), const Color4& color = Colors::White, Direction inversion = Direction::None);
@@ -195,10 +208,20 @@ namespace JGL {
         /// @param color
         void DrawMirrorSprite(const Texture& texture, const Vector2& position, Direction mirror_axis = Direction::Horizontal | Direction::Vertical, float rad_rotation = 0, const Vector2& origin = Vector2(0,0), const Vector2& scale = Vector2(1,1), const Color4& color = Colors::White);
         void DrawMirrorSprite(const Texture* texture, const Vector2& position, Direction mirror_axis = Direction::Horizontal | Direction::Vertical, float rad_rotation = 0, const Vector2& origin = Vector2(0,0), const Vector2& scale = Vector2(1,1), const Color4& color = Colors::White);
+
         /// Draws an outline of a circle on the screen.
+        /// @param color
+        /// @param center
+        /// @param radius
+        /// @param subdivisions
+        /// @param thickness
         void OutlineCircle(const Color4& color, const Vector2& center, float radius, unsigned int subdivisions = 16, float thickness = 1);
 
         /// Draws a filled circle on the screen.
+        /// @param color
+        /// @param center
+        /// @param radius
+        /// @param subdivisions
         void FillCircle(const Color4& color, const Vector2& center, float radius, unsigned int subdivisions = 8);
 
         /// Draws an outline of a triangle on the screen.
@@ -215,6 +238,8 @@ namespace JGL {
         /// Draws a triangle where each corner is defined by a given color, Smoothly transitioning between them.
         void FillGradientTriangle(const Color4& a_color, const Color4& b_color, const Color4& c_color, const Triangle2D& tri);
 
+        /// Draws a smooth, curved line segment between two control points, with the curve controlled by the two inner points.
+        /// @see J3ML::Algorithm::Bezier
         void DrawCubicBezierCurve(const Color4& color, const Vector2& controlA, const Vector2& pointA, const Vector2& pointB, const Vector2& controlB,
                                   int subdivisions = 10, float thickness = 1);
 
@@ -231,6 +256,13 @@ namespace JGL {
         void FillTexturedTriangle();
 
         /// Draws an Arc (section of a circle) to the screen.
+        /// @param color
+        /// @param center
+        /// @param radius
+        /// @param arc_begin
+        /// @param arc_end
+        /// @param subdivisions
+        /// @param thickness
         void DrawArc(const Color4& color, const Vector2& center, float radius, float arc_begin, float arc_end,
                      unsigned int subdivisions, float thickness);
     }