Refactor for documentation

modules/game/const.lua

@@ -1,3 +1,5 @@
+-- @docconsts @{
+
 SkullNone = 0
 SkullYellow = 1
 SkullGreen = 2
@@ -64,3 +66,5 @@ GameTrucatedPingOpcode = 20
 GameReverseCreatureStack = 21
 
 OTSERV_RSA = "109120132967399429278860960508995541528237502902798129123468757937266291492576446330739696001110603907230888610072655818825358503429057592827629436413108566029093628212635953836686562675849720620786279431090218017681061521755056710823876476444260558147179707119674283982419152118103759076030616683978566631413"
+
+-- @}

modules/game/creature.lua

@@ -1,3 +1,7 @@
+-- @docclass Creature
+
+-- @docconsts @{
+
 SkullNone = 0
 SkullYellow = 1
 SkullGreen = 2
@@ -23,6 +27,8 @@ EmblemGreen = 1
 EmblemRed = 2
 EmblemBlue = 3
 
+-- @}
+
 function getSkullImagePath(skullId)
   if skullId == SkullYellow then
     return 'icons/skull_yellow.png'

modules/game/player.lua

@@ -1,3 +1,5 @@
+-- @docclass Player
+
 function Player:isPartyLeader()
   local shield = self:getShield()
   return (shield == ShieldWhiteYellow or
@@ -9,10 +11,10 @@ end
 
 function Player:isPartyMember()
   local shield = self:getShield()
-  return (shield == ShieldWhiteYellow or 
-          shield == ShieldYellow or 
-          shield == ShieldYellowSharedExp or 
-          shield == ShieldYellowNoSharedExpBlink or 
+  return (shield == ShieldWhiteYellow or
+          shield == ShieldYellow or
+          shield == ShieldYellowSharedExp or
+          shield == ShieldYellowNoSharedExpBlink or
           shield == ShieldYellowNoSharedExp or
           shield == ShieldBlueSharedExp or
           shield == ShieldBlueNoSharedExpBlink or
@@ -22,8 +24,8 @@ end
 
 function Player:isPartySharedExperienceActive()
   local shield = self:getShield()
-  return (shield == ShieldYellowSharedExp or 
-          shield == ShieldYellowNoSharedExpBlink or 
+  return (shield == ShieldYellowSharedExp or
+          shield == ShieldYellowNoSharedExpBlink or
           shield == ShieldYellowNoSharedExp or
           shield == ShieldBlueSharedExp or
           shield == ShieldBlueNoSharedExpBlink or

modules/game/protocollogin.lua

@@ -1,3 +1,4 @@
+-- @docclass
 ProtocolLogin = extends(Protocol)
 
 -- private functions