Fix English grammar and add more comments

11 files changed, 19 insertions, 13 deletions

diff --git a/src/gnu_and_bola_brawlers/draw/default.lua b/src/gnu_and_bola_brawlers/draw/default.lua
index a497604..76ced0e 100644
--- a/src/gnu_and_bola_brawlers/draw/default.lua
+++ b/src/gnu_and_bola_brawlers/draw/default.lua
@@ -1,6 +1,6 @@
 local draw = {}
 
---Get current time and update several parameters (time, fps print...)
+--Get current time and update several parameters (timer, scale ...)
 draw.refresh = function()
   local currentTime = love.timer.getTime()
   if nextTime <= currentTime then
@@ -15,7 +15,7 @@ draw.refresh = function()
   love.graphics.print('FPS: ' .. love.timer.getFPS(), 0, 0)
 end
 
---Draw an object using base image  and character data to position, scale, etc...
+--Draw an object using base image and character data for quad, position, etc ...
 draw.object = function(images, character)
   love.graphics.draw(
     images[1],
diff --git a/src/gnu_and_bola_brawlers/keypressed/default.lua b/src/gnu_and_bola_brawlers/keypressed/default.lua
index c2a779c..ea68e2b 100644
--- a/src/gnu_and_bola_brawlers/keypressed/default.lua
+++ b/src/gnu_and_bola_brawlers/keypressed/default.lua
@@ -1,3 +1,5 @@
+--[[ Contains trigger parameters when a key is pressed ]]--
+
 local keypressed = {}
 
 keypressed.trigger = function(character, images, metaSprite, controller, key, scancode)
diff --git a/src/gnu_and_bola_brawlers/keyreleased/default.lua b/src/gnu_and_bola_brawlers/keyreleased/default.lua
index 99376e9..ea9e5e0 100644
--- a/src/gnu_and_bola_brawlers/keyreleased/default.lua
+++ b/src/gnu_and_bola_brawlers/keyreleased/default.lua
@@ -1,3 +1,5 @@
+--[[ Contains trigger parameters when a key is released ]]--
+
 local keyreleased = {}
 
 keyreleased.trigger = function(character, controller, key, scancode)
diff --git a/src/gnu_and_bola_brawlers/load/character.lua b/src/gnu_and_bola_brawlers/load/character.lua
index a569994..d159450 100644
--- a/src/gnu_and_bola_brawlers/load/character.lua
+++ b/src/gnu_and_bola_brawlers/load/character.lua
@@ -1,4 +1,4 @@
---[[ Contains parameters about the game characters ]]--
+--[[ Contains characters parameters ]]--
 
 return {
   bola = {
diff --git a/src/gnu_and_bola_brawlers/load/default.lua b/src/gnu_and_bola_brawlers/load/default.lua
index b6d46f0..43adfdd 100644
--- a/src/gnu_and_bola_brawlers/load/default.lua
+++ b/src/gnu_and_bola_brawlers/load/default.lua
@@ -1,4 +1,4 @@
---[[ Default function called from love.load() and initialize game parameters ]]--
+--[[ Default function called from love.load() to initialize game parameters ]]--
 
 local load = {}
 
diff --git a/src/gnu_and_bola_brawlers/load/images.lua b/src/gnu_and_bola_brawlers/load/images.lua
index d30826d..f4d3bbe 100644
--- a/src/gnu_and_bola_brawlers/load/images.lua
+++ b/src/gnu_and_bola_brawlers/load/images.lua
@@ -1,4 +1,4 @@
---[[ Characters images that contains their meta sprites  ]]--
+--[[ Characters images which contains their meta sprites  ]]--
 
 return {
   bola = {
diff --git a/src/gnu_and_bola_brawlers/load/player_controller_configuration.lua b/src/gnu_and_bola_brawlers/load/player_controller_configuration.lua
index 51e64c4..00f932c 100644
--- a/src/gnu_and_bola_brawlers/load/player_controller_configuration.lua
+++ b/src/gnu_and_bola_brawlers/load/player_controller_configuration.lua
@@ -1,4 +1,4 @@
---[[ Contains the players controllers and translate physic button (keyboard, gamepad, etc.) to a NES button name. ]]--
+--[[ Contains player controllers parameters ]]--
 
 return {
   player1 = {
diff --git a/src/gnu_and_bola_brawlers/load/window_profile.lua b/src/gnu_and_bola_brawlers/load/window_profile.lua
index f6fa4b4..f950b86 100644
--- a/src/gnu_and_bola_brawlers/load/window_profile.lua
+++ b/src/gnu_and_bola_brawlers/load/window_profile.lua
@@ -1,4 +1,4 @@
---[[ Contains general parameters about the window ]]--
+--[[ Contains general window screen parameters ]]--
 
 return {
   mode = {
diff --git a/src/gnu_and_bola_brawlers/meta_sprites/bola/stand.lua b/src/gnu_and_bola_brawlers/meta_sprites/bola/stand.lua
index c9d678d..c280706 100644
--- a/src/gnu_and_bola_brawlers/meta_sprites/bola/stand.lua
+++ b/src/gnu_and_bola_brawlers/meta_sprites/bola/stand.lua
@@ -1,4 +1,4 @@
---[[ Collection of sprites that is necessary to perform character while is motionless ]]--
+--[[ Collection of sprites which is necessary to perform character while is motionless ]]--
 
 return {
   love.graphics.newQuad(images.bola.x * 0, images.bola.y * 0, images.bola.x, images.bola.y, images.bola[1]:getDimensions()),
diff --git a/src/gnu_and_bola_brawlers/meta_sprites/bola/walk.lua b/src/gnu_and_bola_brawlers/meta_sprites/bola/walk.lua
index 8262e5e..f444488 100644
--- a/src/gnu_and_bola_brawlers/meta_sprites/bola/walk.lua
+++ b/src/gnu_and_bola_brawlers/meta_sprites/bola/walk.lua
@@ -1,4 +1,4 @@
---[[ Collection of sprites that is necessary to perform walking movement gestures ]]--
+--[[ Collection of sprites which is necessary to perform walking movement gestures ]]--
 
 return {
   love.graphics.newQuad(images.bola.x * 0, images.bola.y * 1, images.bola.x, images.bola.y, images.bola[1]:getDimensions()),
diff --git a/src/gnu_and_bola_brawlers/update/default.lua b/src/gnu_and_bola_brawlers/update/default.lua
index b14349b..1ea8b10 100644
--- a/src/gnu_and_bola_brawlers/update/default.lua
+++ b/src/gnu_and_bola_brawlers/update/default.lua
@@ -12,18 +12,18 @@ update.animation = function(metaSprite, images, dt)
   --In order to know if it is necessary to change the frame
   if metaSprite.elapsedTime >= (1 / metaSprite.fps) then
     metaSprite.elapsedTime = metaSprite.elapsedTime - (1 / metaSprite.fps)
-    if metaSprite.currentFrame == # metaSprite then --If current frame is equal to long metaSprite list
-      metaSprite.currentFrame = 1 -- Return to first frame
+    if metaSprite.currentFrame == # metaSprite then --If current frame is equal to the long metaSprite list
+      metaSprite.currentFrame = 1 --Return to the first frame
     else
       metaSprite.currentFrame = metaSprite.currentFrame + 1 --Next frame
     end
   end
 
-  images.quad = metaSprite[metaSprite.currentFrame] --Update with new fame
+  images.quad = metaSprite[metaSprite.currentFrame] --Update with new frame
 end
 
 update.motion = function(character, images, metaSprite, dt)
-  -- Check if press button up/down, left/right at same time, no button press and character is not jumping then metaSprite is stand
+  -- Character will be stand if player press up/down, left/right buttons at the same time or when don't press any button
   if ((character.actionUp == true and character.actionDown == true) or (character.actionLeft == true and character.actionRight == true) or (character.actionLeft == false and character.actionRight == false and character.actionUp == false and character.actionDown == false)) and character.actionA == false and character.jump.isJumping == false then
     if metaSprite ~= character.stand then
         print("(update.motion) -> load stand meta sprite")
@@ -106,6 +106,7 @@ update.motion = function(character, images, metaSprite, dt)
   return metaSprite
 end
 
+--Apply gravity when jumping/falling
 update.gravity = function(character, dt)
   if character.jump.velocity ~= 0 then
     character.jump.isJumping = true
@@ -130,6 +131,7 @@ update.gravity = function(character, dt)
   end
 end
 
+--Limit window screen for characters
 update.limit = function(character, dt)
   if character.position.x <= character.origin.x then
     character.position.x = character.origin.x