Merge pull request #10970 from CocosRobot/update_lua_bindings_1426737203

[AUTO]: updating luabinding automatically

cocos/scripting/lua-bindings/auto/api/Action.lua

@@ -5,93 +5,105 @@
 -- @parent_module cc
 
 --------------------------------
---  called before the action start. It will also set the target.
+--  Called before the action start. It will also set the target. <br>
+-- param target A certain target.
 -- @function [parent=#Action] startWithTarget 
 -- @param self
 -- @param #cc.Node target
 -- @return Action#Action self (return value: cc.Action)
         
 --------------------------------
---  Set the original target, since target can be nil.<br>
+-- Set the original target, since target can be nil.<br>
 -- Is the target that were used to run the action. Unless you are doing something complex, like ActionManager, you should NOT call this method.<br>
 -- The target is 'assigned', it is not 'retained'.<br>
--- since v0.8.2
+-- since v0.8.2<br>
+-- param originalTarget Is 'assigned', it is not 'retained'.
 -- @function [parent=#Action] setOriginalTarget 
 -- @param self
 -- @param #cc.Node originalTarget
 -- @return Action#Action self (return value: cc.Action)
         
 --------------------------------
---  returns a clone of action 
+--  Returns a clone of action.<br>
+-- return A clone action.
 -- @function [parent=#Action] clone 
 -- @param self
 -- @return Action#Action ret (return value: cc.Action)
         
 --------------------------------
--- 
+--  Return a original Target. <br>
+-- return A original Target.
 -- @function [parent=#Action] getOriginalTarget 
 -- @param self
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
--- called after the action has finished. It will set the 'target' to nil.<br>
--- IMPORTANT: You should never call "[action stop]" manually. Instead, use: "target->stopAction(action);"
+-- Called after the action has finished. It will set the 'target' to nil.<br>
+-- IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".
 -- @function [parent=#Action] stop 
 -- @param self
 -- @return Action#Action self (return value: cc.Action)
         
 --------------------------------
--- called once per frame. time a value between 0 and 1<br>
--- For example: <br>
--- - 0 means that the action just started<br>
--- - 0.5 means that the action is in the middle<br>
--- - 1 means that the action is over
+-- Called once per frame. time a value between 0 and 1.<br>
+-- For example:<br>
+-- - 0 Means that the action just started.<br>
+-- - 0.5 Means that the action is in the middle.<br>
+-- - 1 Means that the action is over.<br>
+-- param time A value between 0 and 1.
 -- @function [parent=#Action] update 
 -- @param self
 -- @param #float time
 -- @return Action#Action self (return value: cc.Action)
         
 --------------------------------
--- 
+--  Return certain target..<br>
+-- return A certain target.
 -- @function [parent=#Action] getTarget 
 -- @param self
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
---  called every frame with it's delta time, dt in seconds. DON'T override unless you know what you are doing.
+--  Called every frame with it's delta time, dt in seconds. DON'T override unless you know what you are doing. <br>
+-- param dt In seconds.
 -- @function [parent=#Action] step 
 -- @param self
 -- @param #float dt
 -- @return Action#Action self (return value: cc.Action)
         
 --------------------------------
--- 
+--  Changes the tag that is used to identify the action easily. <br>
+-- param tag Used to identify the action easily.
 -- @function [parent=#Action] setTag 
 -- @param self
 -- @param #int tag
 -- @return Action#Action self (return value: cc.Action)
         
 --------------------------------
--- 
+--  Returns a tag that is used to identify the action easily. <br>
+-- return A tag.
 -- @function [parent=#Action] getTag 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  The action will modify the target properties. 
+--  The action will modify the target properties. <br>
+-- param target A certain target.
 -- @function [parent=#Action] setTarget 
 -- @param self
 -- @param #cc.Node target
 -- @return Action#Action self (return value: cc.Action)
         
 --------------------------------
---  return true if the action has finished
+--  Return true if the action has finished. <br>
+-- return Is true if the action has finished.
 -- @function [parent=#Action] isDone 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  returns a new action that performs the exactly the reverse action 
+--  Returns a new action that performs the exactly the reverse action. <br>
+-- return A new action that performs the exactly the reverse action.
 -- @function [parent=#Action] reverse 
 -- @param self
 -- @return Action#Action ret (return value: cc.Action)

cocos/scripting/lua-bindings/auto/api/ActionEase.lua

@@ -5,7 +5,8 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- brief Get the pointer of the inner action.<br>
+-- return The pointer of the inner action.
 -- @function [parent=#ActionEase] getInnerAction 
 -- @param self
 -- @return ActionInterval#ActionInterval ret (return value: cc.ActionInterval)
@@ -36,7 +37,7 @@
 -- @return ActionEase#ActionEase ret (return value: cc.ActionEase)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#ActionEase] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/ActionTween.lua

@@ -5,8 +5,12 @@
 -- @parent_module cc
 
 --------------------------------
--- creates an initializes the action with the property name (key), and the from and to parameters. <br>
--- param duration in seconds
+-- brief Create and initializes the action with the property name (key), and the from and to parameters.<br>
+-- param duration The duration of the ActionTween. It's a value in seconds.<br>
+-- param key The key of property which should be updated.<br>
+-- param from The value of the specified property when the action begin.<br>
+-- param to The value of the specified property when the action end.<br>
+-- return If the creation success, return a pointer of ActionTween; otherwise, return nil.
 -- @function [parent=#ActionTween] create 
 -- @param self
 -- @param #float duration
@@ -29,7 +33,7 @@
 -- @return ActionTween#ActionTween ret (return value: cc.ActionTween)
         
 --------------------------------
--- param dt in seconds
+-- 
 -- @function [parent=#ActionTween] update 
 -- @param self
 -- @param #float dt

cocos/scripting/lua-bindings/auto/api/Animation.lua

@@ -5,21 +5,23 @@
 -- @parent_module cc
 
 --------------------------------
---  Gets the times the animation is going to loop. 0 means animation is not animated. 1, animation is executed one time, ... 
+--  Gets the times the animation is going to loop. 0 means animation is not animated. 1, animation is executed one time, ... <br>
+-- return The times the animation is going to loop.
 -- @function [parent=#Animation] getLoops 
 -- @param self
 -- @return unsigned int#unsigned int ret (return value: unsigned int)
         
 --------------------------------
 --  Adds a SpriteFrame to a Animation.<br>
--- The frame will be added with one "delay unit".
+-- param frame The frame will be added with one "delay unit".
 -- @function [parent=#Animation] addSpriteFrame 
 -- @param self
 -- @param #cc.SpriteFrame frame
 -- @return Animation#Animation self (return value: cc.Animation)
         
 --------------------------------
---  Sets whether to restore the original frame when animation finishes 
+--  Sets whether to restore the original frame when animation finishes. <br>
+-- param restoreOriginalFrame Whether to restore the original frame when animation finishes.
 -- @function [parent=#Animation] setRestoreOriginalFrame 
 -- @param self
 -- @param #bool restoreOriginalFrame
@@ -32,33 +34,38 @@
 -- @return Animation#Animation ret (return value: cc.Animation)
         
 --------------------------------
---  Gets the duration in seconds of the whole animation. It is the result of totalDelayUnits * delayPerUnit 
+--  Gets the duration in seconds of the whole animation. It is the result of totalDelayUnits * delayPerUnit.<br>
+-- return Result of totalDelayUnits * delayPerUnit.
 -- @function [parent=#Animation] getDuration 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  Sets the array of AnimationFrames 
+--  Sets the array of AnimationFrames. <br>
+-- param frames The array of AnimationFrames.
 -- @function [parent=#Animation] setFrames 
 -- @param self
 -- @param #array_table frames
 -- @return Animation#Animation self (return value: cc.Animation)
         
 --------------------------------
---  Gets the array of AnimationFrames 
+--  Gets the array of AnimationFrames.<br>
+-- return The array of AnimationFrames.
 -- @function [parent=#Animation] getFrames 
 -- @param self
 -- @return array_table#array_table ret (return value: array_table)
         
 --------------------------------
---  Sets the times the animation is going to loop. 0 means animation is not animated. 1, animation is executed one time, ... 
+--  Sets the times the animation is going to loop. 0 means animation is not animated. 1, animation is executed one time, ... <br>
+-- param loops The times the animation is going to loop.
 -- @function [parent=#Animation] setLoops 
 -- @param self
 -- @param #unsigned int loops
 -- @return Animation#Animation self (return value: cc.Animation)
         
 --------------------------------
---  Sets the delay in seconds of the "delay unit" 
+--  Sets the delay in seconds of the "delay unit".<br>
+-- param setDelayPerUnit The delay in seconds of the "delay unit".
 -- @function [parent=#Animation] setDelayPerUnit 
 -- @param self
 -- @param #float delayPerUnit
@@ -67,26 +74,30 @@
 --------------------------------
 --  Adds a frame with an image filename. Internally it will create a SpriteFrame and it will add it.<br>
 -- The frame will be added with one "delay unit".<br>
--- Added to facilitate the migration from v0.8 to v0.9.
+-- Added to facilitate the migration from v0.8 to v0.9.<br>
+-- param filename The path of SpriteFrame.
 -- @function [parent=#Animation] addSpriteFrameWithFile 
 -- @param self
 -- @param #string filename
 -- @return Animation#Animation self (return value: cc.Animation)
         
 --------------------------------
---  Gets the total Delay units of the Animation. 
+--  Gets the total Delay units of the Animation. <br>
+-- return The total Delay units of the Animation.
 -- @function [parent=#Animation] getTotalDelayUnits 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  Gets the delay in seconds of the "delay unit" 
+--  Gets the delay in seconds of the "delay unit".<br>
+-- return The delay in seconds of the "delay unit".
 -- @function [parent=#Animation] getDelayPerUnit 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  Checks whether to restore the original frame when animation finishes. 
+--  Checks whether to restore the original frame when animation finishes. <br>
+-- return Restore the original frame when animation finishes.
 -- @function [parent=#Animation] getRestoreOriginalFrame 
 -- @param self
 -- @return bool#bool ret (return value: bool)
@@ -94,7 +105,9 @@
 --------------------------------
 --  Adds a frame with a texture and a rect. Internally it will create a SpriteFrame and it will add it.<br>
 -- The frame will be added with one "delay unit".<br>
--- Added to facilitate the migration from v0.8 to v0.9.
+-- Added to facilitate the migration from v0.8 to v0.9.<br>
+-- param pobTexture A frame with a texture.<br>
+-- param rect The Texture of rect.
 -- @function [parent=#Animation] addSpriteFrameWithTexture 
 -- @param self
 -- @param #cc.Texture2D pobTexture

cocos/scripting/lua-bindings/auto/api/AnimationCache.lua

@@ -7,14 +7,17 @@
 --------------------------------
 --  Returns a Animation that was previously added.<br>
 -- If the name is not found it will return nil.<br>
--- You should retain the returned copy if you are going to use it.
+-- You should retain the returned copy if you are going to use it.<br>
+-- return A Animation that was previously added. If the name is not found it will return nil.
 -- @function [parent=#AnimationCache] getAnimation 
 -- @param self
 -- @param #string name
 -- @return Animation#Animation ret (return value: cc.Animation)
         
 --------------------------------
---  Adds a Animation with a name.
+--  Adds a Animation with a name.<br>
+-- param animation An animation.<br>
+-- param name The name of animation.
 -- @function [parent=#AnimationCache] addAnimation 
 -- @param self
 -- @param #cc.Animation animation
@@ -28,8 +31,9 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  Adds an animation from an NSDictionary<br>
+--  Adds an animation from an NSDictionary.<br>
 -- Make sure that the frames were previously loaded in the SpriteFrameCache.<br>
+-- param dictionary An NSDictionary.<br>
 -- param plist The path of the relative file,it use to find the plist path for load SpriteFrames.<br>
 -- since v1.1
 -- @function [parent=#AnimationCache] addAnimationsWithDictionary 
@@ -39,7 +43,8 @@
 -- @return AnimationCache#AnimationCache self (return value: cc.AnimationCache)
         
 --------------------------------
---  Deletes a Animation from the cache.
+--  Deletes a Animation from the cache.<br>
+-- param name The name of animation.
 -- @function [parent=#AnimationCache] removeAnimation 
 -- @param self
 -- @param #string name
@@ -50,20 +55,22 @@
 -- Make sure that the frames were previously loaded in the SpriteFrameCache.<br>
 -- since v1.1<br>
 -- js addAnimations<br>
--- lua addAnimations
+-- lua addAnimations<br>
+-- param plist An animation from a plist file.
 -- @function [parent=#AnimationCache] addAnimationsWithFile 
 -- @param self
 -- @param #string plist
 -- @return AnimationCache#AnimationCache self (return value: cc.AnimationCache)
         
 --------------------------------
---  Purges the cache. It releases all the Animation objects and the shared instance.
+--  Purges the cache. It releases all the Animation objects and the shared instance. 
 -- @function [parent=#AnimationCache] destroyInstance 
 -- @param self
 -- @return AnimationCache#AnimationCache self (return value: cc.AnimationCache)
         
 --------------------------------
---  Returns the shared instance of the Animation cache 
+--  Returns the shared instance of the Animation cache. <br>
+-- return The shared instance of the Animation cache.
 -- @function [parent=#AnimationCache] getInstance 
 -- @param self
 -- @return AnimationCache#AnimationCache ret (return value: cc.AnimationCache)

cocos/scripting/lua-bindings/auto/api/AnimationFrame.lua

@@ -5,7 +5,8 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+--  Set the SpriteFrame.<br>
+-- param frame A SpriteFrame will be used.
 -- @function [parent=#AnimationFrame] setSpriteFrame 
 -- @param self
 -- @param #cc.SpriteFrame frame
@@ -19,7 +20,8 @@
 -- @return map_table#map_table ret (return value: map_table)
 
 --------------------------------
---  Sets the units of time the frame takes 
+--  Sets the units of time the frame takes.<br>
+-- param delayUnits The units of time the frame takes.
 -- @function [parent=#AnimationFrame] setDelayUnits 
 -- @param self
 -- @param #float delayUnits
@@ -32,26 +34,32 @@
 -- @return AnimationFrame#AnimationFrame ret (return value: cc.AnimationFrame)
         
 --------------------------------
--- 
+--  Return a SpriteFrameName to be used.<br>
+-- return a SpriteFrameName to be used.
 -- @function [parent=#AnimationFrame] getSpriteFrame 
 -- @param self
 -- @return SpriteFrame#SpriteFrame ret (return value: cc.SpriteFrame)
         
 --------------------------------
---  Gets the units of time the frame takes 
+--  Gets the units of time the frame takes.<br>
+-- return The units of time the frame takes.
 -- @function [parent=#AnimationFrame] getDelayUnits 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  Sets user infomation 
+--  Sets user infomation.<br>
+-- param userInfo A dictionary as UserInfo.
 -- @function [parent=#AnimationFrame] setUserInfo 
 -- @param self
 -- @param #map_table userInfo
 -- @return AnimationFrame#AnimationFrame self (return value: cc.AnimationFrame)
         
 --------------------------------
--- Creates the animation frame with a spriteframe, number of delay units and a notification user info<br>
+-- Creates the animation frame with a spriteframe, number of delay units and a notification user info.<br>
+-- param spriteFrame The animation frame with a spriteframe.<br>
+-- param delayUnits Number of delay units.<br>
+-- param userInfo A notification user info.<br>
 -- since 3.0
 -- @function [parent=#AnimationFrame] create 
 -- @param self

cocos/scripting/lua-bindings/auto/api/AtlasNode.lua

@@ -6,7 +6,7 @@
 
 --------------------------------
 --  updates the Atlas (indexed vertex array).<br>
--- Shall be overridden in subclasses
+-- Shall be overridden in subclasses.
 -- @function [parent=#AtlasNode] updateAtlasValues 
 -- @param self
 -- @return AtlasNode#AtlasNode self (return value: cc.AtlasNode)
@@ -18,7 +18,7 @@
 -- @return Texture2D#Texture2D ret (return value: cc.Texture2D)
         
 --------------------------------
--- 
+--  Set an buffer manager of the texture vertex. 
 -- @function [parent=#AtlasNode] setTextureAtlas 
 -- @param self
 -- @param #cc.TextureAtlas textureAtlas
@@ -36,7 +36,8 @@
 -- @return AtlasNode#AtlasNode self (return value: cc.AtlasNode)
         
 --------------------------------
--- 
+--  Return the buffer manager of the texture vertex. <br>
+-- return Return A TextureAtlas.
 -- @function [parent=#AtlasNode] getTextureAtlas 
 -- @param self
 -- @return TextureAtlas#TextureAtlas ret (return value: cc.TextureAtlas)
@@ -69,7 +70,11 @@
 -- @return AtlasNode#AtlasNode self (return value: cc.AtlasNode)
         
 --------------------------------
---  creates a AtlasNode  with an Atlas file the width and height of each item and the quantity of items to render
+--  creates a AtlasNode  with an Atlas file the width and height of each item and the quantity of items to render.<br>
+-- param filename The path of Atlas file.<br>
+-- param tileWidth The width of the item.<br>
+-- param tileHeight The height of the item.<br>
+-- param itemsToRender The quantity of items to render.
 -- @function [parent=#AtlasNode] create 
 -- @param self
 -- @param #string filename

cocos/scripting/lua-bindings/auto/api/AudioEngine.lua

@@ -10,8 +10,8 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  Sets the current playback position of an audio instance.<br>
--- param audioID an audioID returned by the play2d function<br>
+-- Sets the current playback position of an audio instance.<br>
+-- param audioID An audioID returned by the play2d function.<br>
 -- return 
 -- @function [parent=#AudioEngine] setCurrentTime 
 -- @param self
@@ -20,76 +20,77 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  Gets the volume value of an audio instance.<br>
--- param audioID an audioID returned by the play2d function<br>
--- return volume value (range from 0.0 to 1.0)
+-- Gets the volume value of an audio instance.<br>
+-- param audioID An audioID returned by the play2d function.<br>
+-- return Volume value (range from 0.0 to 1.0).
 -- @function [parent=#AudioEngine] getVolume 
 -- @param self
 -- @param #int audioID
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  Uncache the audio data from internal buffer.<br>
--- AudioEngine cache audio data on ios platform<br>
+-- Uncache the audio data from internal buffer.<br>
+-- AudioEngine cache audio data on ios,mac, and win32 platform.<br>
 -- warning This can lead to stop related audio first.<br>
--- param filePath The path of an audio file
+-- param filePath Audio file path.
 -- @function [parent=#AudioEngine] uncache 
 -- @param self
 -- @param #string filePath
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
---  Resume all suspended audio instances 
+--  Resume all suspended audio instances. 
 -- @function [parent=#AudioEngine] resumeAll 
 -- @param self
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
---  Stop all audio instances 
+--  Stop all audio instances. 
 -- @function [parent=#AudioEngine] stopAll 
 -- @param self
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
---  Pause an audio instance.<br>
--- param audioID an audioID returned by the play2d function
+-- Pause an audio instance.<br>
+-- param audioID An audioID returned by the play2d function.
 -- @function [parent=#AudioEngine] pause 
 -- @param self
 -- @param #int audioID
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
--- Release related objects<br>
--- warning It must be called before the application exit
+-- Release objects relating to AudioEngine.<br>
+-- warning It must be called before the application exit.
 -- @function [parent=#AudioEngine] end 
 -- @param self
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
--- 
+-- Gets the maximum number of simultaneous audio instance of AudioEngine.
 -- @function [parent=#AudioEngine] getMaxAudioInstance 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  Gets the current playback position of an audio instance.<br>
--- param audioID an audioID returned by the play2d function<br>
--- return the current playback position of an audio instance
+-- Gets the current playback position of an audio instance.<br>
+-- param audioID An audioID returned by the play2d function.<br>
+-- return The current playback position of an audio instance.
 -- @function [parent=#AudioEngine] getCurrentTime 
 -- @param self
 -- @param #int audioID
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Sets the maximum number of simultaneous audio instance for AudioEngine.<br>
+-- param maxInstances The maximum number of simultaneous audio instance.
 -- @function [parent=#AudioEngine] setMaxAudioInstance 
 -- @param self
 -- @param #int maxInstances
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  Checks whether an audio instance is loop.<br>
--- param audioID an audioID returned by the play2d function<br>
+-- Checks whether an audio instance is loop.<br>
+-- param audioID An audioID returned by the play2d function.<br>
 -- return Whether or not an audio instance is loop.
 -- @function [parent=#AudioEngine] isLoop 
 -- @param self
@@ -97,23 +98,22 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  Pause all playing audio instances 
+--  Pause all playing audio instances. 
 -- @function [parent=#AudioEngine] pauseAll 
 -- @param self
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
---  Uncache all audio data from internal buffer.<br>
--- warning All audio will be stopped first.<br>
--- param
+-- Uncache all audio data from internal buffer.<br>
+-- warning All audio will be stopped first.
 -- @function [parent=#AudioEngine] uncacheAll 
 -- @param self
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
---  Sets volume for an audio instance.<br>
--- param audioID an audioID returned by the play2d function<br>
--- param volume volume value (range from 0.0 to 1.0)
+-- Sets volume for an audio instance.<br>
+-- param audioID An audioID returned by the play2d function.<br>
+-- param volume Volume value (range from 0.0 to 1.0).
 -- @function [parent=#AudioEngine] setVolume 
 -- @param self
 -- @param #int audioID
@@ -121,12 +121,13 @@
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
---  Play 2d sound<br>
--- param filePath The path of an audio file<br>
--- param loop Whether audio instance loop or not<br>
--- param volume volume value (range from 0.0 to 1.0)<br>
--- param profile a profile for audio instance<br>
--- return an audio ID. It allows you to dynamically change the behavior of an audio instance on the fly.
+-- Play 2d sound.<br>
+-- param filePath The path of an audio file.<br>
+-- param loop Whether audio instance loop or not.<br>
+-- param volume Volume value (range from 0.0 to 1.0).<br>
+-- param profile A profile for audio instance. When profile is not specified, default profile will be used.<br>
+-- return An audio ID. It allows you to dynamically change the behavior of an audio instance on the fly.<br>
+-- see `AudioProfile`
 -- @function [parent=#AudioEngine] play2d 
 -- @param self
 -- @param #string filePath
@@ -136,43 +137,43 @@
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  Returns the state of an audio instance.<br>
--- param audioID an audioID returned by the play2d function<br>
--- return the status of an audio instance
+-- Returns the state of an audio instance.<br>
+-- param audioID An audioID returned by the play2d function.<br>
+-- return The status of an audio instance.
 -- @function [parent=#AudioEngine] getState 
 -- @param self
 -- @param #int audioID
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  Resume an audio instance.<br>
--- param audioID an audioID returned by the play2d function
+-- Resume an audio instance.<br>
+-- param audioID An audioID returned by the play2d function.
 -- @function [parent=#AudioEngine] resume 
 -- @param self
 -- @param #int audioID
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
---  Stop an audio instance.<br>
--- param audioID an audioID returned by the play2d function
+-- Stop an audio instance.<br>
+-- param audioID An audioID returned by the play2d function.
 -- @function [parent=#AudioEngine] stop 
 -- @param self
 -- @param #int audioID
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
---  Gets the duration of an audio instance.<br>
--- param audioID an audioID returned by the play2d function<br>
--- return the duration of an audio instance
+-- Gets the duration of an audio instance.<br>
+-- param audioID An audioID returned by the play2d function.<br>
+-- return The duration of an audio instance.
 -- @function [parent=#AudioEngine] getDuration 
 -- @param self
 -- @param #int audioID
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  Sets whether an audio instance loop or not. <br>
--- param audioID an audioID returned by the play2d function<br>
--- param loop Whether audio instance loop or not
+-- Sets whether an audio instance loop or not.<br>
+-- param audioID An audioID returned by the play2d function.<br>
+-- param loop Whether audio instance loop or not.
 -- @function [parent=#AudioEngine] setLoop 
 -- @param self
 -- @param #int audioID
@@ -180,8 +181,8 @@
 -- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
         
 --------------------------------
---   Gets the default profile of audio instances<br>
--- return the default profile of audio instances
+-- Gets the default profile of audio instances.<br>
+-- return The default profile of audio instances.
 -- @function [parent=#AudioEngine] getDefaultProfile 
 -- @param self
 -- @return experimental::AudioProfile#experimental::AudioProfile ret (return value: cc.experimental::AudioProfile)

cocos/scripting/lua-bindings/auto/api/CardinalSplineTo.lua

@@ -5,21 +5,25 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+--  Return a PointArray.<br>
+-- return A PointArray.
 -- @function [parent=#CardinalSplineTo] getPoints 
 -- @param self
 -- @return point_table#point_table ret (return value: point_table)
         
 --------------------------------
--- 
+--  It will update the target position and change the _previousPosition to newPos<br>
+-- param newPos The new position.
 -- @function [parent=#CardinalSplineTo] updatePosition 
 -- @param self
 -- @param #vec2_table newPos
 -- @return CardinalSplineTo#CardinalSplineTo self (return value: cc.CardinalSplineTo)
         
 --------------------------------
--- initializes the action with a duration and an array of points<br>
--- param duration in seconds
+-- Initializes the action with a duration and an array of points.<br>
+-- param duration In seconds.<br>
+-- param point An PointArray.<br>
+-- param tension Goodness of fit.
 -- @function [parent=#CardinalSplineTo] initWithDuration 
 -- @param self
 -- @param #float duration
@@ -47,7 +51,7 @@
 -- @return CardinalSplineTo#CardinalSplineTo ret (return value: cc.CardinalSplineTo)
         
 --------------------------------
--- param time in seconds.
+-- param time In seconds.
 -- @function [parent=#CardinalSplineTo] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/CatmullRomBy.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  initializes the action with a duration and an array of points 
+--  Initializes the action with a duration and an array of points.<br>
+-- param dt In seconds.<br>
+-- param points An PointArray.
 -- @function [parent=#CatmullRomBy] initWithDuration 
 -- @param self
 -- @param #float dt

cocos/scripting/lua-bindings/auto/api/CatmullRomTo.lua

@@ -5,8 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
--- initializes the action with a duration and an array of points<br>
--- param dt in seconds
+-- Initializes the action with a duration and an array of points.<br>
+-- param dt In seconds.<br>
+-- param points An PointArray.
 -- @function [parent=#CatmullRomTo] initWithDuration 
 -- @param self
 -- @param #float dt

cocos/scripting/lua-bindings/auto/api/Controller.lua

@@ -4,11 +4,11 @@
 -- @parent_module cc
 
 --------------------------------
---  Activate receives key event from external key. e.g. back,menu.<br>
+-- Activate receives key event from external key. e.g. back,menu.<br>
 -- Controller receives only standard key which contained within enum Key by default.<br>
 -- warning The API only work on the android platform for support diversified game controller.<br>
--- param externalKeyCode  external key code<br>
--- param receive  true if external key event on this controller should be receive, false otherwise.
+-- param externalKeyCode   External key code.<br>
+-- param receive   True if external key event on this controller should be receive, false otherwise.
 -- @function [parent=#Controller] receiveExternalKeyEvent 
 -- @param self
 -- @param #int externalKeyCode
@@ -16,25 +16,25 @@
 -- @return Controller#Controller self (return value: cc.Controller)
         
 --------------------------------
--- 
+-- Gets the name of this Controller object.
 -- @function [parent=#Controller] getDeviceName 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+-- Indicates whether the Controller is connected.
 -- @function [parent=#Controller] isConnected 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Gets the Controller id.
 -- @function [parent=#Controller] getDeviceId 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  Changes the tag that is used to identify the controller easily.<br>
+-- Changes the tag that is used to identify the controller easily.<br>
 -- param tag   A integer that identifies the controller.
 -- @function [parent=#Controller] setTag 
 -- @param self
@@ -49,22 +49,23 @@
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  To start discovering new controllers<br>
--- warning The API only work on the IOS platform.Empty implementation on Android
+-- Start discovering new controllers.<br>
+-- warning The API only work on the IOS platform. Empty implementation on other platform.
 -- @function [parent=#Controller] startDiscoveryController 
 -- @param self
 -- @return Controller#Controller self (return value: cc.Controller)
         
 --------------------------------
---  End the discovery process<br>
--- warning The API only work on the IOS platform.Empty implementation on Android
+-- Stop the discovery process.<br>
+-- warning The API only work on the IOS platform.Empty implementation on other platform.
 -- @function [parent=#Controller] stopDiscoveryController 
 -- @param self
 -- @return Controller#Controller self (return value: cc.Controller)
         
 --------------------------------
---  Gets a controller with its tag<br>
--- param tag   An identifier to find the controller.
+-- Gets a Controller object with tag.<br>
+-- param tag   An identifier to find the controller.<br>
+-- return A Controller object.
 -- @function [parent=#Controller] getControllerByTag 
 -- @param self
 -- @param #int tag

cocos/scripting/lua-bindings/auto/api/Director.lua

@@ -5,14 +5,14 @@
 
 --------------------------------
 --  Pauses the running scene.<br>
--- The running scene will be _drawed_ but all scheduled timers will be paused<br>
--- While paused, the draw rate will be 4 FPS to reduce CPU consumption
+-- The running scene will be _drawed_ but all scheduled timers will be paused.<br>
+-- While paused, the draw rate will be 4 FPS to reduce CPU consumption.
 -- @function [parent=#Director] pause 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Sets the EventDispatcher associated with this director <br>
+--  Sets the EventDispatcher associated with this director.<br>
 -- since v3.0
 -- @function [parent=#Director] setEventDispatcher 
 -- @param self
@@ -30,13 +30,14 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- 
+-- Gets content scale factor.<br>
+-- see Director::setContentScaleFactor()
 -- @function [parent=#Director] getContentScaleFactor 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  returns the size of the OpenGL view in pixels.
+--  Returns the size of the OpenGL view in pixels. 
 -- @function [parent=#Director] getWinSizeInPixels 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
@@ -48,13 +49,14 @@
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  sets the OpenGL default values 
+--  Sets the OpenGL default values.<br>
+-- It will enable alpha blending, disable depth test.
 -- @function [parent=#Director] setGLDefaultValues 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Sets the ActionManager associated with this director<br>
+--  Sets the ActionManager associated with this director.<br>
 -- since v2.0
 -- @function [parent=#Director] setActionManager 
 -- @param self
@@ -62,22 +64,24 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  enables/disables OpenGL alpha blending 
+--  Enables/disables OpenGL alpha blending. 
 -- @function [parent=#Director] setAlphaBlending 
 -- @param self
 -- @param #bool on
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Pops out all scenes from the stack until the root scene in the queue.<br>
+-- Pops out all scenes from the stack until the root scene in the queue.<br>
 -- This scene will replace the running one.<br>
--- Internally it will call `popToSceneStackLevel(1)`
+-- Internally it will call `popToSceneStackLevel(1)`.
 -- @function [parent=#Director] popToRootScene 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- 
+-- Adds a matrix to the top of specified type of matrix stack.<br>
+-- param type Matrix type.<br>
+-- param mat The matrix that to be added.
 -- @function [parent=#Director] loadMatrix 
 -- @param self
 -- @param #int type
@@ -86,7 +90,7 @@
         
 --------------------------------
 --  This object will be visited after the main scene is visited.<br>
--- This object MUST implement the "visit" selector.<br>
+-- This object MUST implement the "visit" function.<br>
 -- Useful to hook a notification object, like Notifications (http:github.com/manucorporat/CCNotifications)<br>
 -- since v0.99.5
 -- @function [parent=#Director] getNotificationNode 
@@ -94,13 +98,13 @@
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
---  returns the size of the OpenGL view in points.
+--  Returns the size of the OpenGL view in points. 
 -- @function [parent=#Director] getWinSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
--- 
+--  Gets singleton of TextureCache. 
 -- @function [parent=#Director] getTextureCache 
 -- @param self
 -- @return TextureCache#TextureCache ret (return value: cc.TextureCache)
@@ -115,7 +119,7 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  returns visible origin of the OpenGL view in points.
+--  Returns visible origin coordinate of the OpenGL view in points. 
 -- @function [parent=#Director] getVisibleOrigin 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
@@ -127,47 +131,47 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  enables/disables OpenGL depth test 
+--  Enables/disables OpenGL depth test. 
 -- @function [parent=#Director] setDepthTest 
 -- @param self
 -- @param #bool on
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- get Frame Rate
+-- Gets Frame Rate.
 -- @function [parent=#Director] getFrameRate 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  seconds per frame 
+--  Get seconds per frame. 
 -- @function [parent=#Director] getSecondsPerFrame 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+--  Cleras all types of matrix stack, and add indentity matrix to these matrix stacks. 
 -- @function [parent=#Director] resetMatrixStack 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  converts an OpenGL coordinate to a UIKit coordinate<br>
--- Useful to convert node points to window points for calls such as glScissor
+-- Converts an OpenGL coordinate to a screen coordinate.<br>
+-- Useful to convert node points to window points for calls such as glScissor.
 -- @function [parent=#Director] convertToUI 
 -- @param self
 -- @param #vec2_table point
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
         
 --------------------------------
--- 
+--  Clones a specified type matrix and put it to the top of specified type of matrix stack. 
 -- @function [parent=#Director] pushMatrix 
 -- @param self
 -- @param #int type
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  sets the default values based on the Configuration info 
+--  Sets the default values based on the Configuration info. 
 -- @function [parent=#Director] setDefaultValues 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
@@ -179,7 +183,7 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  Sets the Scheduler associated with this director<br>
+--  Sets the Scheduler associated with this director.<br>
 -- since v2.0
 -- @function [parent=#Director] setScheduler 
 -- @param self
@@ -187,7 +191,7 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- 
+--  Gets the top matrix of specified type of matrix stack. 
 -- @function [parent=#Director] getMatrix 
 -- @param self
 -- @param #int type
@@ -195,14 +199,14 @@
         
 --------------------------------
 --  The main loop is triggered again.<br>
--- Call this function only if [stopAnimation] was called earlier<br>
--- warning Don't call this function to start the main loop. To run the main loop call runWithScene
+-- Call this function only if [stopAnimation] was called earlier.<br>
+-- warning Don't call this function to start the main loop. To run the main loop call runWithScene.
 -- @function [parent=#Director] startAnimation 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Get the GLView, where everything is rendered<br>
+-- Get the GLView.<br>
 -- js NA<br>
 -- lua NA
 -- @function [parent=#Director] getOpenGLView 
@@ -210,13 +214,13 @@
 -- @return GLView#GLView ret (return value: cc.GLView)
         
 --------------------------------
---  Get current running Scene. Director can only run one Scene at a time 
+--  Gets current running Scene. Director can only run one Scene at a time. 
 -- @function [parent=#Director] getRunningScene 
 -- @param self
 -- @return Scene#Scene ret (return value: cc.Scene)
         
 --------------------------------
---  Sets the glViewport
+--  Sets the glViewport.
 -- @function [parent=#Director] setViewport 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
@@ -239,21 +243,21 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Resumes the paused scene<br>
+--  Resumes the paused scene.<br>
 -- The scheduled timers will be activated again.<br>
--- The "delta time" will be 0 (as if the game wasn't paused)
+-- The "delta time" will be 0 (as if the game wasn't paused).
 -- @function [parent=#Director] resume 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- 
+--  Whether or not `_nextDeltaTimeZero` is set to 0. 
 -- @function [parent=#Director] isNextDeltaTimeZero 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  set clear values for the color buffers, value range of each element is [0.0, 1.0] 
+--  Sets clear values for the color buffers, value range of each element is [0.0, 1.0]. 
 -- @function [parent=#Director] setClearColor 
 -- @param self
 -- @param #color4f_table clearColor
@@ -261,22 +265,23 @@
         
 --------------------------------
 --  Ends the execution, releases the running scene.<br>
--- It doesn't remove the OpenGL view from its parent. You have to do it manually.<br>
 -- lua endToLua
 -- @function [parent=#Director] end 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- 
+-- Sets the GLView. <br>
+-- lua NA<br>
+-- js NA
 -- @function [parent=#Director] setOpenGLView 
 -- @param self
 -- @param #cc.GLView openGLView
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  converts a UIKit coordinate to an OpenGL coordinate<br>
--- Useful to convert (multi) touch coordinates to the current layout (portrait or landscape)
+-- Converts a screen coordinate to an OpenGL coordinate.<br>
+-- Useful to convert (multi) touch coordinates to the current layout (portrait or landscape).
 -- @function [parent=#Director] convertToGL 
 -- @param self
 -- @param #vec2_table point
@@ -297,7 +302,7 @@
 -- @return unsigned int#unsigned int ret (return value: unsigned int)
         
 --------------------------------
---  Enters the Director's main loop with the given Scene.<br>
+-- Enters the Director's main loop with the given Scene.<br>
 -- Call it to run only your FIRST scene.<br>
 -- Don't call it if there is already a running scene.<br>
 -- It will call pushScene: and then it will call startAnimation
@@ -307,7 +312,8 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- 
+-- Sets the notification node.<br>
+-- see Director::getNotificationNode()
 -- @function [parent=#Director] setNotificationNode 
 -- @param self
 -- @param #cc.Node node
@@ -321,13 +327,13 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Restart the director
+--  Restart the director. 
 -- @function [parent=#Director] restart 
 -- @param self
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Pops out a scene from the stack.<br>
+-- Pops out a scene from the stack.<br>
 -- This scene will replace the running one.<br>
 -- The running scene will be deleted. If there are no more scenes in the stack the execution is terminated.<br>
 -- ONLY call it if there is a running scene.
@@ -336,34 +342,36 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- 
+--  Adds an identity matrix to the top of specified type of matrxi stack. 
 -- @function [parent=#Director] loadIdentityMatrix 
 -- @param self
 -- @param #int type
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Whether or not to display the FPS on the bottom-left corner 
+--  Whether or not to display the FPS on the bottom-left corner. 
 -- @function [parent=#Director] isDisplayStats 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+--  Sets OpenGL projection. 
 -- @function [parent=#Director] setProjection 
 -- @param self
 -- @param #int projection
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Returns the Console <br>
+--  Returns the Console associated with this director.<br>
 -- since v3.0
 -- @function [parent=#Director] getConsole 
 -- @param self
 -- @return Console#Console ret (return value: cc.Console)
         
 --------------------------------
--- 
+-- Multipies a matrix to the top of specified type of matrix stack.<br>
+-- param type Matrix type.<br>
+-- param mat The matrix that to be multipied.
 -- @function [parent=#Director] multiplyMatrix 
 -- @param self
 -- @param #int type
@@ -371,42 +379,44 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- / FIXME: missing description 
+-- Gets the distance between camera and near clipping frane.<br>
+-- It is correct for default camera that near clipping frane is the same as screen.
 -- @function [parent=#Director] getZEye 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Sets the detal time between current frame and next frame is 0.<br>
+-- This value will be used in Schedule, and will affect all functions that are using frame detal time, such as Actions.<br>
+-- This value will take effect only one time.
 -- @function [parent=#Director] setNextDeltaTimeZero 
 -- @param self
 -- @param #bool nextDeltaTimeZero
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
--- 
+--  Pops the top matrix of the specified type of matrix stack. 
 -- @function [parent=#Director] popMatrix 
 -- @param self
 -- @param #int type
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  returns visible size of the OpenGL view in points.<br>
--- the value is equal to getWinSize if don't invoke<br>
--- GLView::setDesignResolutionSize()
+-- Returns visible size of the OpenGL view in points.<br>
+-- The value is equal to `Director::getWinSize()` if don't invoke `GLView::setDesignResolutionSize()`.
 -- @function [parent=#Director] getVisibleSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
---  Gets the Scheduler associated with this director<br>
+--  Gets the Scheduler associated with this director.<br>
 -- since v2.0
 -- @function [parent=#Director] getScheduler 
 -- @param self
 -- @return Scheduler#Scheduler ret (return value: cc.Scheduler)
         
 --------------------------------
---  Suspends the execution of the running scene, pushing it on the stack of suspended scenes.<br>
+-- Suspends the execution of the running scene, pushing it on the stack of suspended scenes.<br>
 -- The new scene will be executed.<br>
 -- Try to avoid big stacks of pushed scenes to reduce memory allocation. <br>
 -- ONLY call it if there is a running scene.
@@ -416,26 +426,26 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Get the FPS value 
+--  Gets the FPS value. 
 -- @function [parent=#Director] getAnimationInterval 
 -- @param self
 -- @return double#double ret (return value: double)
         
 --------------------------------
---  Whether or not the Director is paused 
+--  Whether or not the Director is paused. 
 -- @function [parent=#Director] isPaused 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  Display the FPS on the bottom-left corner 
+--  Display the FPS on the bottom-left corner. 
 -- @function [parent=#Director] setDisplayStats 
 -- @param self
 -- @param #bool displayStats
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Gets the EventDispatcher associated with this director <br>
+--  Gets the EventDispatcher associated with this director.<br>
 -- since v3.0
 -- @function [parent=#Director] getEventDispatcher 
 -- @param self
@@ -450,21 +460,21 @@
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Set the FPS value. 
+--  Sets the FPS value. FPS = 1/internal. 
 -- @function [parent=#Director] setAnimationInterval 
 -- @param self
 -- @param #double interval
 -- @return Director#Director self (return value: cc.Director)
         
 --------------------------------
---  Gets the ActionManager associated with this director<br>
+--  Gets the ActionManager associated with this director.<br>
 -- since v2.0
 -- @function [parent=#Director] getActionManager 
 -- @param self
 -- @return ActionManager#ActionManager ret (return value: cc.ActionManager)
         
 --------------------------------
---  returns a shared instance of the director 
+--  Returns a shared instance of the director. 
 -- @function [parent=#Director] getInstance 
 -- @param self
 -- @return Director#Director ret (return value: cc.Director)

cocos/scripting/lua-bindings/auto/api/EaseBackIn.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseBackIn action. If creation failed, return nil.
 -- @function [parent=#EaseBackIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseBackIn#EaseBackIn ret (return value: cc.EaseBackIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseBackIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseBackInOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseBackInOut action. If creation failed, return nil.
 -- @function [parent=#EaseBackInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseBackInOut#EaseBackInOut ret (return value: cc.EaseBackInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseBackInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseBackOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseBackOut action. If creation failed, return nil.
 -- @function [parent=#EaseBackOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseBackOut#EaseBackOut ret (return value: cc.EaseBackOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseBackOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseBezierAction.lua

@@ -5,7 +5,7 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- brief Set the bezier parameters.
 -- @function [parent=#EaseBezierAction] setBezierParamer 
 -- @param self
 -- @param #float p0
@@ -15,7 +15,9 @@
 -- @return EaseBezierAction#EaseBezierAction self (return value: cc.EaseBezierAction)
         
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseBezierAction action. If creation failed, return nil.
 -- @function [parent=#EaseBezierAction] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -28,7 +30,7 @@
 -- @return EaseBezierAction#EaseBezierAction ret (return value: cc.EaseBezierAction)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseBezierAction] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseBounceIn.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseBounceIn action. If creation failed, return nil.
 -- @function [parent=#EaseBounceIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseBounceIn#EaseBounceIn ret (return value: cc.EaseBounceIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseBounceIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseBounceInOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseBounceInOut action. If creation failed, return nil.
 -- @function [parent=#EaseBounceInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseBounceInOut#EaseBounceInOut ret (return value: cc.EaseBounceInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseBounceInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseBounceOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseBounceOut action. If creation failed, return nil.
 -- @function [parent=#EaseBounceOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseBounceOut#EaseBounceOut ret (return value: cc.EaseBounceOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseBounceOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseCircleActionIn.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseCircleActionIn action. If creation failed, return nil.
 -- @function [parent=#EaseCircleActionIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseCircleActionIn#EaseCircleActionIn ret (return value: cc.EaseCircleActionIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseCircleActionIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseCircleActionInOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseCircleActionInOut action. If creation failed, return nil.
 -- @function [parent=#EaseCircleActionInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseCircleActionInOut#EaseCircleActionInOut ret (return value: cc.EaseCircleActionInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseCircleActionInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseCircleActionOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseCircleActionOut action. If creation failed, return nil.
 -- @function [parent=#EaseCircleActionOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseCircleActionOut#EaseCircleActionOut ret (return value: cc.EaseCircleActionOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseCircleActionOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseCubicActionIn.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseCubicActionIn action. If creation failed, return nil.
 -- @function [parent=#EaseCubicActionIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseCubicActionIn#EaseCubicActionIn ret (return value: cc.EaseCubicActionIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseCubicActionIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseCubicActionInOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseCubicActionInOut action. If creation failed, return nil.
 -- @function [parent=#EaseCubicActionInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseCubicActionInOut#EaseCubicActionInOut ret (return value: cc.EaseCubicActionInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseCubicActionInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseCubicActionOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseCubicActionOut action. If creation failed, return nil.
 -- @function [parent=#EaseCubicActionOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseCubicActionOut#EaseCubicActionOut ret (return value: cc.EaseCubicActionOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseCubicActionOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseElastic.lua

@@ -5,14 +5,16 @@
 -- @parent_module cc
 
 --------------------------------
---  set period of the wave in radians. 
+-- brief Set period of the wave in radians.<br>
+-- param fPeriod The value will be set.
 -- @function [parent=#EaseElastic] setPeriod 
 -- @param self
 -- @param #float fPeriod
 -- @return EaseElastic#EaseElastic self (return value: cc.EaseElastic)
         
 --------------------------------
---  get period of the wave in radians. default is 0.3 
+-- brief Get period of the wave in radians. Default value is 0.3.<br>
+-- return Return the period of the wave in radians.
 -- @function [parent=#EaseElastic] getPeriod 
 -- @param self
 -- @return float#float ret (return value: float)

cocos/scripting/lua-bindings/auto/api/EaseElasticIn.lua

@@ -20,7 +20,7 @@
 -- @return EaseElasticIn#EaseElasticIn ret (return value: cc.EaseElasticIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseElasticIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseElasticInOut.lua

@@ -20,7 +20,7 @@
 -- @return EaseElasticInOut#EaseElasticInOut ret (return value: cc.EaseElasticInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseElasticInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseElasticOut.lua

@@ -20,7 +20,7 @@
 -- @return EaseElasticOut#EaseElasticOut ret (return value: cc.EaseElasticOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseElasticOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseExponentialIn.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseExponentialIn action. If creation failed, return nil.
 -- @function [parent=#EaseExponentialIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseExponentialIn#EaseExponentialIn ret (return value: cc.EaseExponentialIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseExponentialIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseExponentialInOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseExponentialInOut action. If creation failed, return nil.
 -- @function [parent=#EaseExponentialInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseExponentialInOut#EaseExponentialInOut ret (return value: cc.EaseExponentialInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseExponentialInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseExponentialOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseExponentialOut action. If creation failed, return nil.
 -- @function [parent=#EaseExponentialOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseExponentialOut#EaseExponentialOut ret (return value: cc.EaseExponentialOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseExponentialOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseIn.lua

@@ -5,7 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
---  Creates the action with the inner action and the rate parameter 
+-- brief Create the action with the inner action and the rate parameter.<br>
+-- param action The pointer of the inner action.<br>
+-- param rate The value of the rate parameter.<br>
+-- return A pointer of EaseIn action. If creation failed, return nil.
 -- @function [parent=#EaseIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -19,7 +22,7 @@
 -- @return EaseIn#EaseIn ret (return value: cc.EaseIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseInOut.lua

@@ -5,7 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
---  Creates the action with the inner action and the rate parameter 
+-- brief Create the action with the inner action and the rate parameter.<br>
+-- param action The pointer of the inner action.<br>
+-- param rate The value of the rate parameter.<br>
+-- return A pointer of EaseInOut action. If creation failed, return nil.
 -- @function [parent=#EaseInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -19,7 +22,7 @@
 -- @return EaseInOut#EaseInOut ret (return value: cc.EaseInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseOut.lua

@@ -5,7 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
---  Creates the action with the inner action and the rate parameter 
+-- brief Create the action with the inner action and the rate parameter.<br>
+-- param action The pointer of the inner action.<br>
+-- param rate The value of the rate parameter.<br>
+-- return A pointer of EaseOut action. If creation failed, return nil.
 -- @function [parent=#EaseOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -19,7 +22,7 @@
 -- @return EaseOut#EaseOut ret (return value: cc.EaseOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseQuadraticActionIn.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseQuadraticActionIn action. If creation failed, return nil.
 -- @function [parent=#EaseQuadraticActionIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseQuadraticActionIn#EaseQuadraticActionIn ret (return value: cc.EaseQuadraticActionIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseQuadraticActionIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseQuadraticActionInOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseQuadraticActionInOut action. If creation failed, return nil.
 -- @function [parent=#EaseQuadraticActionInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseQuadraticActionInOut#EaseQuadraticActionInOut ret (return value: cc.EaseQuadraticActionInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseQuadraticActionInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseQuadraticActionOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseQuadraticActionOut action. If creation failed, return nil.
 -- @function [parent=#EaseQuadraticActionOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseQuadraticActionOut#EaseQuadraticActionOut ret (return value: cc.EaseQuadraticActionOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseQuadraticActionOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseQuarticActionIn.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseQuarticActionIn action. If creation failed, return nil.
 -- @function [parent=#EaseQuarticActionIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseQuarticActionIn#EaseQuarticActionIn ret (return value: cc.EaseQuarticActionIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseQuarticActionIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseQuarticActionInOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseQuarticActionInOut action. If creation failed, return nil.
 -- @function [parent=#EaseQuarticActionInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseQuarticActionInOut#EaseQuarticActionInOut ret (return value: cc.EaseQuarticActionInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseQuarticActionInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseQuarticActionOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseQuarticActionOut action. If creation failed, return nil.
 -- @function [parent=#EaseQuarticActionOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseQuarticActionOut#EaseQuarticActionOut ret (return value: cc.EaseQuarticActionOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseQuarticActionOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseQuinticActionIn.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseQuinticActionIn action. If creation failed, return nil.
 -- @function [parent=#EaseQuinticActionIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseQuinticActionIn#EaseQuinticActionIn ret (return value: cc.EaseQuinticActionIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseQuinticActionIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseQuinticActionInOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseQuinticActionInOut action. If creation failed, return nil.
 -- @function [parent=#EaseQuinticActionInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseQuinticActionInOut#EaseQuinticActionInOut ret (return value: cc.EaseQuinticActionInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseQuinticActionInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseQuinticActionOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseQuinticActionOut action. If creation failed, return nil.
 -- @function [parent=#EaseQuinticActionOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseQuinticActionOut#EaseQuinticActionOut ret (return value: cc.EaseQuinticActionOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseQuinticActionOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseRateAction.lua

@@ -5,14 +5,16 @@
 -- @parent_module cc
 
 --------------------------------
---  set rate value for the actions 
+-- brief Set the rate value for the ease rate action.<br>
+-- param rate The value will be set.
 -- @function [parent=#EaseRateAction] setRate 
 -- @param self
 -- @param #float rate
 -- @return EaseRateAction#EaseRateAction self (return value: cc.EaseRateAction)
         
 --------------------------------
---  get rate value for the actions 
+-- brief Get the rate value of the ease rate action.<br>
+-- return Return the rate value of the ease rate action.
 -- @function [parent=#EaseRateAction] getRate 
 -- @param self
 -- @return float#float ret (return value: float)

cocos/scripting/lua-bindings/auto/api/EaseSineIn.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseSineIn action. If creation failed, return nil.
 -- @function [parent=#EaseSineIn] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseSineIn#EaseSineIn ret (return value: cc.EaseSineIn)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseSineIn] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseSineInOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseSineInOut action. If creation failed, return nil.
 -- @function [parent=#EaseSineInOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseSineInOut#EaseSineInOut ret (return value: cc.EaseSineInOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseSineInOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/EaseSineOut.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action 
+-- brief Create the action with the inner action.<br>
+-- param action The pointer of the inner action.<br>
+-- return A pointer of EaseSineOut action. If creation failed, return nil.
 -- @function [parent=#EaseSineOut] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -18,7 +20,7 @@
 -- @return EaseSineOut#EaseSineOut ret (return value: cc.EaseSineOut)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#EaseSineOut] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/FadeOutBLTiles.lua

@@ -5,8 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
--- creates the action with the grid size and the duration <br>
--- param duration in seconds
+-- brief Create the action with the grid size and the duration.<br>
+-- param duration Specify the duration of the FadeOutBLTiles action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- return If the creation success, return a pointer of FadeOutBLTiles action; otherwise, return nil.
 -- @function [parent=#FadeOutBLTiles] create 
 -- @param self
 -- @param #float duration

cocos/scripting/lua-bindings/auto/api/FadeOutDownTiles.lua

@@ -5,8 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
--- creates the action with the grid size and the duration<br>
--- param duration in seconds
+-- brief Create the action with the grid size and the duration.<br>
+-- param duration Specify the duration of the FadeOutDownTiles action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- return If the creation success, return a pointer of FadeOutDownTiles action; otherwise, return nil.
 -- @function [parent=#FadeOutDownTiles] create 
 -- @param self
 -- @param #float duration

cocos/scripting/lua-bindings/auto/api/FadeOutTRTiles.lua

@@ -5,21 +5,25 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- brief Show the tile at specified position.<br>
+-- param pos The position index of the tile should be shown.
 -- @function [parent=#FadeOutTRTiles] turnOnTile 
 -- @param self
 -- @param #vec2_table pos
 -- @return FadeOutTRTiles#FadeOutTRTiles self (return value: cc.FadeOutTRTiles)
         
 --------------------------------
--- 
+-- brief Hide the tile at specified position.<br>
+-- param pos The position index of the tile should be hide.
 -- @function [parent=#FadeOutTRTiles] turnOffTile 
 -- @param self
 -- @param #vec2_table pos
 -- @return FadeOutTRTiles#FadeOutTRTiles self (return value: cc.FadeOutTRTiles)
         
 --------------------------------
--- 
+-- brief Show part of the tile.<br>
+-- param pos The position index of the tile should be shown.<br>
+-- param distance The percentage that the tile should be shown.
 -- @function [parent=#FadeOutTRTiles] transformTile 
 -- @param self
 -- @param #vec2_table pos
@@ -27,7 +31,10 @@
 -- @return FadeOutTRTiles#FadeOutTRTiles self (return value: cc.FadeOutTRTiles)
         
 --------------------------------
--- 
+-- brief Calculate the percentage a tile should be shown.<br>
+-- param pos The position index of the tile.<br>
+-- param time The current percentage of the action.<br>
+-- return Return the percentage the tile should be shown.
 -- @function [parent=#FadeOutTRTiles] testFunc 
 -- @param self
 -- @param #size_table pos
@@ -35,8 +42,10 @@
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- creates the action with the grid size and the duration<br>
--- param duration in seconds
+-- brief Create the action with the grid size and the duration.<br>
+-- param duration Specify the duration of the FadeOutTRTiles action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- return If the creation success, return a pointer of FadeOutTRTiles action; otherwise, return nil.
 -- @function [parent=#FadeOutTRTiles] create 
 -- @param self
 -- @param #float duration
@@ -50,7 +59,7 @@
 -- @return FadeOutTRTiles#FadeOutTRTiles ret (return value: cc.FadeOutTRTiles)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#FadeOutTRTiles] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/FadeOutUpTiles.lua

@@ -5,8 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
--- creates the action with the grid size and the duration <br>
--- param duration in seconds
+-- brief Create the action with the grid size and the duration.<br>
+-- param duration Specify the duration of the FadeOutUpTiles action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- return If the creation success, return a pointer of FadeOutUpTiles action; otherwise, return nil.
 -- @function [parent=#FadeOutUpTiles] create 
 -- @param self
 -- @param #float duration

cocos/scripting/lua-bindings/auto/api/FiniteTimeAction.lua

@@ -5,14 +5,16 @@
 -- @parent_module cc
 
 --------------------------------
---  set duration in seconds of the action
+--  Set duration in seconds of the action. <br>
+-- param duration In seconds of the action.
 -- @function [parent=#FiniteTimeAction] setDuration 
 -- @param self
 -- @param #float duration
 -- @return FiniteTimeAction#FiniteTimeAction self (return value: cc.FiniteTimeAction)
         
 --------------------------------
---  get duration in seconds of the action
+--  Get duration in seconds of the action. <br>
+-- return The duration in seconds of the action.
 -- @function [parent=#FiniteTimeAction] getDuration 
 -- @param self
 -- @return float#float ret (return value: float)

cocos/scripting/lua-bindings/auto/api/FlipX3D.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action with duration 
+-- brief Create the action with duration.<br>
+-- param duration Specify the duration of the FilpX3D action. It's a value in seconds.<br>
+-- return If the creation sucess, return a pointer of FilpX3D action; otherwise, return nil.
 -- @function [parent=#FlipX3D] create 
 -- @param self
 -- @param #float duration
@@ -18,7 +20,7 @@
 -- @return FlipX3D#FlipX3D ret (return value: cc.FlipX3D)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#FlipX3D] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/FlipY3D.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action with duration 
+-- brief Create the action with duration.<br>
+-- param duration Specify the duration of the FlipY3D action. It's a value in seconds.<br>
+-- return If the creation sucess, return a pointer of FlipY3D action; otherwise, return nil.
 -- @function [parent=#FlipY3D] create 
 -- @param self
 -- @param #float duration
@@ -18,7 +20,7 @@
 -- @return FlipY3D#FlipY3D ret (return value: cc.FlipY3D)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#FlipY3D] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/Follow.lua

@@ -5,14 +5,14 @@
 -- @parent_module cc
 
 --------------------------------
---  alter behavior - turn on/off boundary 
+--  Alter behavior - turn on/off boundary. 
 -- @function [parent=#Follow] setBoundarySet 
 -- @param self
 -- @param #bool value
 -- @return Follow#Follow self (return value: cc.Follow)
         
 --------------------------------
--- 
+--  Return boundarySet.
 -- @function [parent=#Follow] isBoundarySet 
 -- @param self
 -- @return bool#bool ret (return value: bool)

cocos/scripting/lua-bindings/auto/api/Grid3DAction.lua

@@ -11,7 +11,7 @@
 -- @return Grid3DAction#Grid3DAction ret (return value: cc.Grid3DAction)
         
 --------------------------------
---  returns the grid 
+-- 
 -- @function [parent=#Grid3DAction] getGrid 
 -- @param self
 -- @return GridBase#GridBase ret (return value: cc.GridBase)

cocos/scripting/lua-bindings/auto/api/GridAction.lua

@@ -5,7 +5,8 @@
 -- @parent_module cc
 
 --------------------------------
---  returns the grid 
+-- brief Get the pointer of GridBase.<br>
+-- return The pointer of GridBase.
 -- @function [parent=#GridAction] getGrid 
 -- @param self
 -- @return GridBase#GridBase ret (return value: cc.GridBase)

cocos/scripting/lua-bindings/auto/api/JumpTiles3D.lua

@@ -5,34 +5,42 @@
 -- @parent_module cc
 
 --------------------------------
---  amplitude rate 
+-- brief Get the amplitude rate of the effect.<br>
+-- return Return the amplitude rate of the effect.
 -- @function [parent=#JumpTiles3D] getAmplitudeRate 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Set the amplitude to the effect.<br>
+-- param amplitude The value of amplitude will be set.
 -- @function [parent=#JumpTiles3D] setAmplitude 
 -- @param self
 -- @param #float amplitude
 -- @return JumpTiles3D#JumpTiles3D self (return value: cc.JumpTiles3D)
         
 --------------------------------
--- 
+-- brief Set the ampliture rate of the effect.<br>
+-- param amplitudeRate The value of amplitude rate will be set.
 -- @function [parent=#JumpTiles3D] setAmplitudeRate 
 -- @param self
 -- @param #float amplitudeRate
 -- @return JumpTiles3D#JumpTiles3D self (return value: cc.JumpTiles3D)
         
 --------------------------------
---  amplitude of the sin
+-- brief Get the amplitude of the effect.<br>
+-- return Return the amplitude of the effect.
 -- @function [parent=#JumpTiles3D] getAmplitude 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- creates the action with the number of jumps, the sin amplitude, the grid size and the duration <br>
--- param duration in seconds
+-- brief Create the action with the number of jumps, the sin amplitude, the grid size and the duration.<br>
+-- param duration Specify the duration of the JumpTiles3D action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param numberOfJumps Specify the jump tiles count.<br>
+-- param amplitude Specify the amplitude of the JumpTiles3D action.<br>
+-- return If the creation success, return a pointer of JumpTiles3D action; otherwise, return nil.
 -- @function [parent=#JumpTiles3D] create 
 -- @param self
 -- @param #float duration
@@ -48,7 +56,7 @@
 -- @return JumpTiles3D#JumpTiles3D ret (return value: cc.JumpTiles3D)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#JumpTiles3D] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/Label.lua

@@ -11,14 +11,14 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- Enable shadow for the label<br>
--- todo support blur for shadow effect
+-- Enable shadow effect to Label.<br>
+-- todo Support blur for shadow effect.
 -- @function [parent=#Label] enableShadow 
 -- @param self
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
---  Sets the untransformed size of the label in a more efficient way. 
+--  Sets the untransformed size of the Label in a more efficient way. 
 -- @function [parent=#Label] setDimensions 
 -- @param self
 -- @param #float width
@@ -26,7 +26,7 @@
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
--- 
+--  Return the text the Label is displaying.
 -- @function [parent=#Label] getString 
 -- @param self
 -- @return string#string ret (return value: string)
@@ -38,30 +38,28 @@
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  disable shadow/outline/glow rendering 
+-- Disable all effect to Label.
 -- @function [parent=#Label] disableEffect 
 -- @param self
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
---  set TTF configuration for Label 
+-- Sets a new TTF configuration to Label.<br>
+-- see `TTFConfig`
 -- @function [parent=#Label] setTTFConfig 
 -- @param self
 -- @param #cc._ttfConfig ttfConfig
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  Returns the text color of this label<br>
--- Only support for TTF and system font<br>
--- warning Different from the color of Node.
+--  Returns the text color of the Label.
 -- @function [parent=#Label] getTextColor 
 -- @param self
 -- @return color4b_table#color4b_table ret (return value: color4b_table)
         
 --------------------------------
---  Sets the untransformed size of the label.<br>
--- The label's width be used for text align if the set value not equal zero.<br>
--- The label's max line width will be equal to the same value.
+-- Makes the Label exactly this untransformed width.<br>
+-- The Label's width be used for text align if the value not equal zero.
 -- @function [parent=#Label] setWidth 
 -- @param self
 -- @param #float width
@@ -74,35 +72,36 @@
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+--  Returns the Label's text horizontal alignment.
 -- @function [parent=#Label] getHorizontalAlignment 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  clip upper and lower margin for reduce height of label.
+--  Makes the Label to clip upper and lower margin for reduce height of Label.
 -- @function [parent=#Label] setClipMarginEnabled 
 -- @param self
 -- @param #bool clipEnabled
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
---  changes the string to render<br>
--- warning It is as expensive as changing the string if you haven't set up TTF/BMFont/CharMap for the label.
+--  Sets the text that this Label is to display.
 -- @function [parent=#Label] setString 
 -- @param self
 -- @param #string text
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
--- 
+-- Sets a new system font to Label.<br>
+-- param font A font file or a font family name.<br>
+-- warning
 -- @function [parent=#Label] setSystemFontName 
 -- @param self
--- @param #string systemFont
+-- @param #string font
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
--- 
+--  Sets a new bitmap font to Label 
 -- @function [parent=#Label] setBMFontFilePath 
 -- @param self
 -- @param #string bmfontFilePath
@@ -116,8 +115,8 @@
 -- @return FontAtlas#FontAtlas ret (return value: cc.FontAtlas)
         
 --------------------------------
---  Sets the line height of the label<br>
--- warning Not support system font<br>
+--  Sets the line height of the Label.<br>
+-- warning Not support system font.<br>
 -- since v3.2.0
 -- @function [parent=#Label] setLineHeight 
 -- @param self
@@ -132,7 +131,7 @@
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
---  update content immediately.
+--  Update content immediately.
 -- @function [parent=#Label] updateContent 
 -- @param self
 -- @return Label#Label self (return value: cc.Label)
@@ -144,7 +143,8 @@
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- Specify what happens when a line is too long for Label.<br>
+-- param breakWithoutSpace Lines are automatically broken between words if this value is false.
 -- @function [parent=#Label] setLineBreakWithoutSpace 
 -- @param self
 -- @param #bool breakWithoutSpace
@@ -157,7 +157,8 @@
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  only support for TTF 
+-- Enable outline effect to Label.<br>
+-- warning Limiting use to only when the Label created with true type font or system font.
 -- @function [parent=#Label] enableOutline 
 -- @param self
 -- @param #color4b_table outlineColor
@@ -165,8 +166,8 @@
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
---  Returns the additional kerning of this label<br>
--- warning Not support system font<br>
+-- Returns the additional kerning of the Label.<br>
+-- warning Not support system font.<br>
 -- since v3.2.0
 -- @function [parent=#Label] getAdditionalKerning 
 -- @param self
@@ -191,59 +192,60 @@
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
---  Sets the max line width of the label.<br>
--- The label's max line width be used for force line breaks if the set value not equal zero.<br>
--- The label's width and max line width has not always to be equal.
+-- Makes the Label at most this line untransformed width.<br>
+-- The Label's max line width be used for force line breaks if the value not equal zero.
 -- @function [parent=#Label] setMaxLineWidth 
 -- @param self
 -- @param #float maxLineWidth
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
--- 
+--  Returns the system font used by the Label.
 -- @function [parent=#Label] getSystemFontName 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+--  Sets the Label's text vertical alignment.
 -- @function [parent=#Label] setVerticalAlignment 
 -- @param self
 -- @param #int vAlignment
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
---  Returns the line height of this label<br>
--- warning Not support system font
+-- Returns the line height of this Label.<br>
+-- warning Not support system font.<br>
+-- since v3.2.0
 -- @function [parent=#Label] getLineHeight 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Returns the TTF configuration object used by the Label.<br>
+-- see `TTFConfig`
 -- @function [parent=#Label] getTTFConfig 
 -- @param self
 -- @return _ttfConfig#_ttfConfig ret (return value: cc._ttfConfig)
         
 --------------------------------
--- 
+--  Returns the Label's text vertical alignment.
 -- @function [parent=#Label] getVerticalAlignment 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  Sets the text color of the label<br>
--- Only support for TTF and system font<br>
--- warning Different from the color of Node.
+-- Sets the text color of Label.<br>
+-- The text color is different from the color of Node.<br>
+-- warning Limiting use to only when the Label created with true type font or system font. 
 -- @function [parent=#Label] setTextColor 
 -- @param self
 -- @param #color4b_table color
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
---  Sets the untransformed size of the label.<br>
--- The label's height be used for text align if the set value not equal zero.<br>
--- The text will display of incomplete when the size of label not enough to support display all text.
+-- Makes the Label exactly this untransformed height.<br>
+-- The Label's height be used for text align if the value not equal zero.<br>
+-- The text will display of incomplete when the size of Label not enough to support display all text.
 -- @function [parent=#Label] setHeight 
 -- @param self
 -- @param #float height
@@ -256,22 +258,24 @@
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  only support for TTF 
+-- Enable glow effect to Label.<br>
+-- warning Limiting use to only when the Label created with true type font.
 -- @function [parent=#Label] enableGlow 
 -- @param self
 -- @param #color4b_table glowColor
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
--- 
+-- Provides a way to treats each character like a Sprite.<br>
+-- warning No support system font.
 -- @function [parent=#Label] getLetter 
 -- @param self
 -- @param #int lettetIndex
 -- @return Sprite#Sprite ret (return value: cc.Sprite)
         
 --------------------------------
---  Sets the additional kerning of the label<br>
--- warning Not support system font<br>
+-- Sets the additional kerning of the Label.<br>
+-- warning Not support system font.<br>
 -- since v3.2.0
 -- @function [parent=#Label] setAdditionalKerning 
 -- @param self
@@ -279,25 +283,25 @@
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
--- 
+--  Returns the bitmap font path used by the Label.
 -- @function [parent=#Label] getSystemFontSize 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+--  Returns the Label's text horizontal alignment.
 -- @function [parent=#Label] getTextAlignment 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+--  Returns the bitmap font used by the Label.
 -- @function [parent=#Label] getBMFontFilePath 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+--  Sets the Label's text horizontal alignment.
 -- @function [parent=#Label] setHorizontalAlignment 
 -- @param self
 -- @param #int hAlignment
@@ -313,24 +317,32 @@
 -- @return Label#Label self (return value: cc.Label)
 
 --------------------------------
--- 
+-- warning This method is not recommended for game developers.
 -- @function [parent=#Label] requestSystemFontRefresh 
 -- @param self
 -- @return Label#Label self (return value: cc.Label)
         
 --------------------------------
--- 
+-- Allocates and initializes a Label, with a bitmap font file.<br>
+-- param bmfontPath A bitmap font file, it's a FNT format.<br>
+-- param text The initial text.<br>
+-- param hAlignment Text horizontal alignment.<br>
+-- param maxLineWidth The max line width.<br>
+-- param imageOffset <br>
+-- return An automatically released Label object.<br>
+-- see setBMFontFilePath setMaxLineWidth
 -- @function [parent=#Label] createWithBMFont 
 -- @param self
--- @param #string bmfontFilePath
+-- @param #string bmfontPath
 -- @param #string text
--- @param #int alignment
+-- @param #int hAlignment
 -- @param #int maxLineWidth
 -- @param #vec2_table imageOffset
 -- @return Label#Label ret (return value: cc.Label)
         
 --------------------------------
--- 
+-- Allocates and initializes a Label, with default settings.<br>
+-- return An automatically released Label object.
 -- @function [parent=#Label] create 
 -- @param self
 -- @return Label#Label ret (return value: cc.Label)
@@ -348,8 +360,15 @@
 -- @return Label#Label ret (return value: cc.Label)
 
 --------------------------------
---  Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment.<br>
--- warning It will generate texture by the platform-dependent code
+-- Allocates and initializes a Label, base on platform-dependent API.<br>
+-- param text The initial text.<br>
+-- param font A font file or a font family name.<br>
+-- param fontSize The font size. This value must be > 0.<br>
+-- param dimensions <br>
+-- param hAlignment The text horizontal alignment.<br>
+-- param vAlignment The text vertical alignment.<br>
+-- warning It will generate texture by the platform-dependent code.<br>
+-- return An automatically released Label object.
 -- @function [parent=#Label] createWithSystemFont 
 -- @param self
 -- @param #string text

cocos/scripting/lua-bindings/auto/api/Lens3D.lua

@@ -5,40 +5,50 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- brief Set the center position of lens effect.<br>
+-- param The center position will be set.
 -- @function [parent=#Lens3D] setPosition 
 -- @param self
 -- @param #vec2_table position
 -- @return Lens3D#Lens3D self (return value: cc.Lens3D)
         
 --------------------------------
---  Set whether lens is concave 
+-- brief Set whether lens is concave.<br>
+-- param concave Whether lens is concave.
 -- @function [parent=#Lens3D] setConcave 
 -- @param self
 -- @param #bool concave
 -- @return Lens3D#Lens3D self (return value: cc.Lens3D)
         
 --------------------------------
---  Set lens center position 
+-- brief Set the value of lens effect.<br>
+-- param lensEffect The value of lens effect will be set.
 -- @function [parent=#Lens3D] setLensEffect 
 -- @param self
 -- @param #float lensEffect
 -- @return Lens3D#Lens3D self (return value: cc.Lens3D)
         
 --------------------------------
--- 
+-- brief Get the center position of lens effect.<br>
+-- return The center position of lens effect.
 -- @function [parent=#Lens3D] getPosition 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
         
 --------------------------------
---  Get lens center position 
+-- brief Get the value of lens effect. Default value is 0.7.<br>
+-- return The value of lens effect.
 -- @function [parent=#Lens3D] getLensEffect 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  creates the action with center position, radius, a grid size and duration 
+-- brief Create the action with center position, radius, a grid size and duration.<br>
+-- param duration Specify the duration of the Lens3D action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param position Specify the center position of the lens.<br>
+-- param radius Specify the radius of the lens.<br>
+-- return If the creation sucess, return a pointer of Lens3D action; otherwise, return nil.
 -- @function [parent=#Lens3D] create 
 -- @param self
 -- @param #float duration
@@ -54,7 +64,7 @@
 -- @return Lens3D#Lens3D ret (return value: cc.Lens3D)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#Lens3D] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/Liquid.lua

@@ -5,33 +5,42 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- brief Get the amplitude rate of the effect.<br>
+-- return Return the amplitude rate of the effect.
 -- @function [parent=#Liquid] getAmplitudeRate 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Set the amplitude to the effect.<br>
+-- param amplitude The value of amplitude will be set.
 -- @function [parent=#Liquid] setAmplitude 
 -- @param self
 -- @param #float amplitude
 -- @return Liquid#Liquid self (return value: cc.Liquid)
         
 --------------------------------
--- 
+-- brief Set the ampliture rate of the effect.<br>
+-- param amplitudeRate The value of amplitude rate will be set.
 -- @function [parent=#Liquid] setAmplitudeRate 
 -- @param self
 -- @param #float amplitudeRate
 -- @return Liquid#Liquid self (return value: cc.Liquid)
         
 --------------------------------
--- 
+-- brief Get the amplitude of the effect.<br>
+-- return Return the amplitude of the effect.
 -- @function [parent=#Liquid] getAmplitude 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  creates the action with amplitude, a grid and duration 
+-- brief Create the action with amplitude, grid size, waves count and duration.<br>
+-- param duration Specify the duration of the Liquid action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param waves Specify the waves count of the Liquid action.<br>
+-- param amplitude Specify the amplitude of the Liquid action.<br>
+-- return If the creation sucess, return a pointer of Liquid action; otherwise, return nil.
 -- @function [parent=#Liquid] create 
 -- @param self
 -- @param #float duration
@@ -47,7 +56,7 @@
 -- @return Liquid#Liquid ret (return value: cc.Liquid)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#Liquid] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/OrbitCamera.lua

@@ -5,7 +5,15 @@
 -- @parent_module cc
 
 --------------------------------
---  creates a OrbitCamera action with radius, delta-radius,  z, deltaZ, x, deltaX 
+--  Creates a OrbitCamera action with radius, delta-radius,  z, deltaZ, x, deltaX. <br>
+-- param t Duration in seconds.<br>
+-- param radius The start radius.<br>
+-- param deltaRadius The delta radius.<br>
+-- param angelZ The start Angel in Z.<br>
+-- param deltaAngleZ The delta angle in Z.<br>
+-- param angelX The start Angel in X.<br>
+-- param deltaAngleX The delta angle in X.<br>
+-- return An OrbitCamera.
 -- @function [parent=#OrbitCamera] create 
 -- @param self
 -- @param #float t

cocos/scripting/lua-bindings/auto/api/PageTurn3D.lua

@@ -5,7 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
---  create the action 
+-- brief Create an action with duration, grid size.<br>
+-- param duration Specify the duration of the PageTurn3D action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- return If the creation sucess, return a pointer of PageTurn3D action; otherwise, return nil.
 -- @function [parent=#PageTurn3D] create 
 -- @param self
 -- @param #float duration
@@ -25,7 +28,7 @@
 -- @return GridBase#GridBase ret (return value: cc.GridBase)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#PageTurn3D] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/ProgressFromTo.lua

@@ -5,8 +5,11 @@
 -- @parent_module cc
 
 --------------------------------
--- Creates and initializes the action with a duration, a "from" percentage and a "to" percentage <br>
--- param duration in seconds
+-- brief Create and initializes the action with a duration, a "from" percentage and a "to" percentage.<br>
+-- param duration Specify the duration of the ProgressFromTo action. It's a value in seconds.<br>
+-- param fromPercentage Specify the source percentage.<br>
+-- param toPercentage Specify the destination percentage.<br>
+-- return If the creation sucess, return a pointer of ProgressFromTo action; otherwise, return nil.
 -- @function [parent=#ProgressFromTo] create 
 -- @param self
 -- @param #float duration
@@ -34,7 +37,7 @@
 -- @return ProgressFromTo#ProgressFromTo ret (return value: cc.ProgressFromTo)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#ProgressFromTo] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/ProgressTo.lua

@@ -5,8 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
--- Creates and initializes with a duration and a percent <br>
--- param duration in seconds
+-- brief Create and initializes with a duration and a destination percentage.<br>
+-- param duration Specify the duration of the ProgressTo action. It's a value in seconds.<br>
+-- param percent Specify the destination percentage.<br>
+-- return If the creation sucess, return a pointer of ProgressTo action; otherwise, return nil.
 -- @function [parent=#ProgressTo] create 
 -- @param self
 -- @param #float duration
@@ -33,7 +35,7 @@
 -- @return ProgressTo#ProgressTo ret (return value: cc.ProgressTo)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#ProgressTo] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/ReuseGrid.lua

@@ -5,7 +5,9 @@
 -- @parent_module cc
 
 --------------------------------
---  creates an action with the number of times that the current grid will be reused 
+-- brief Create an action with the number of times that the current grid will be reused.<br>
+-- param times Specify times the grid will be reused.<br>
+-- return Return a pointer of ReuseGrid. When the creation failed, return nil.
 -- @function [parent=#ReuseGrid] create 
 -- @param self
 -- @param #int times

cocos/scripting/lua-bindings/auto/api/Ripple3D.lua

@@ -5,46 +5,59 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- brief Set the amplitude rate of ripple effect.<br>
+-- param fAmplitudeRate The amplitude rate of ripple effect.
 -- @function [parent=#Ripple3D] setAmplitudeRate 
 -- @param self
 -- @param #float fAmplitudeRate
 -- @return Ripple3D#Ripple3D self (return value: cc.Ripple3D)
         
 --------------------------------
--- 
+-- brief Get the amplitude rate of ripple effect.<br>
+-- return The amplitude rate of ripple effect.
 -- @function [parent=#Ripple3D] getAmplitudeRate 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Set the amplitude of ripple effect.<br>
+-- param fAmplitude The amplitude of ripple effect.
 -- @function [parent=#Ripple3D] setAmplitude 
 -- @param self
 -- @param #float fAmplitude
 -- @return Ripple3D#Ripple3D self (return value: cc.Ripple3D)
         
 --------------------------------
--- 
+-- brief Get the amplitude of ripple effect.<br>
+-- return The amplitude of ripple effect.
 -- @function [parent=#Ripple3D] getAmplitude 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  set center position 
+-- brief Set the center position of ripple effect.<br>
+-- param position The center position of ripple effect will be set.
 -- @function [parent=#Ripple3D] setPosition 
 -- @param self
 -- @param #vec2_table position
 -- @return Ripple3D#Ripple3D self (return value: cc.Ripple3D)
         
 --------------------------------
---  get center position 
+-- brief Get the center position of ripple effect.<br>
+-- return The center position of ripple effect.
 -- @function [parent=#Ripple3D] getPosition 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
         
 --------------------------------
---  creates the action with radius, number of waves, amplitude, a grid size and duration 
+-- brief Create the action with center position, radius, number of waves, amplitude, a grid size and duration.<br>
+-- param duration Specify the duration of the Ripple3D action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param position Specify the center position of the ripple effect.<br>
+-- param radius Specify the radius of the ripple effect.<br>
+-- param waves Specify the waves count of the ripple effect.<br>
+-- param amplitude Specify the amplitude of the ripple effect.<br>
+-- return If the creation sucess, return a pointer of Ripple3D action; otherwise, return nil.
 -- @function [parent=#Ripple3D] create 
 -- @param self
 -- @param #float duration
@@ -62,7 +75,7 @@
 -- @return Ripple3D#Ripple3D ret (return value: cc.Ripple3D)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#Ripple3D] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/Scheduler.lua

@@ -17,12 +17,14 @@
 -- @return Scheduler#Scheduler self (return value: cc.Scheduler)
         
 --------------------------------
--- 
+-- Gets the time scale of schedule callbacks.<br>
+-- see Scheduler::setTimeScale()
 -- @function [parent=#Scheduler] getTimeScale 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
+-- Constructor<br>
 -- js ctor
 -- @function [parent=#Scheduler] Scheduler 
 -- @param self

cocos/scripting/lua-bindings/auto/api/Shaky3D.lua

@@ -5,10 +5,15 @@
 -- @parent_module cc
 
 --------------------------------
---  creates the action with a range, shake Z vertices, a grid and duration 
+-- brief Create the action with a range, shake Z vertices, a grid and duration.<br>
+-- param duration Specify the duration of the Shaky3D action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param range Specify the range of the shaky effect.<br>
+-- param shakeZ Specify whether shake on the z axis.<br>
+-- return If the creation sucess, return a pointer of Shaky3D action; otherwise, return nil.
 -- @function [parent=#Shaky3D] create 
 -- @param self
--- @param #float duration
+-- @param #float initWithDuration
 -- @param #size_table gridSize
 -- @param #int range
 -- @param #bool shakeZ

cocos/scripting/lua-bindings/auto/api/ShakyTiles3D.lua

@@ -5,8 +5,12 @@
 -- @parent_module cc
 
 --------------------------------
--- creates the action with a range, whether or not to shake Z vertices, a grid size, and duration <br>
--- param duration in seconds
+-- brief Create the action with a range, shake Z vertices, a grid and duration.<br>
+-- param duration Specify the duration of the ShakyTiles3D action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param range Specify the range of the shaky effect.<br>
+-- param shakeZ Specify whether shake on the z axis.<br>
+-- return If the creation success, return a pointer of ShakyTiles3D action; otherwise, return nil.
 -- @function [parent=#ShakyTiles3D] create 
 -- @param self
 -- @param #float duration
@@ -22,7 +26,7 @@
 -- @return ShakyTiles3D#ShakyTiles3D ret (return value: cc.ShakyTiles3D)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#ShakyTiles3D] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/ShatteredTiles3D.lua

@@ -5,8 +5,12 @@
 -- @parent_module cc
 
 --------------------------------
--- creates the action with a range, whether of not to shatter Z vertices, a grid size and duration <br>
--- param duration in seconds
+-- brief Create the action with a range, whether of not to shatter Z vertices, grid size and duration.<br>
+-- param duration Specify the duration of the ShatteredTiles3D action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param range Specify the range of the shatter effect.<br>
+-- param shatterZ Specify whether shatter on the z axis.<br>
+-- return If the creation success, return a pointer of ShatteredTiles3D action; otherwise, return nil.
 -- @function [parent=#ShatteredTiles3D] create 
 -- @param self
 -- @param #float duration
@@ -22,7 +26,7 @@
 -- @return ShatteredTiles3D#ShatteredTiles3D ret (return value: cc.ShatteredTiles3D)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#ShatteredTiles3D] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/ShuffleTiles.lua

@@ -12,8 +12,11 @@
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
--- creates the action with a random seed, the grid size and the duration<br>
--- param duration in seconds
+-- brief Create the action with grid size, random seed and duration.<br>
+-- param duration Specify the duration of the ShuffleTiles action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param seed Specify the random seed.<br>
+-- return If the creation success, return a pointer of ShuffleTiles action; otherwise, return nil.
 -- @function [parent=#ShuffleTiles] create 
 -- @param self
 -- @param #float duration
@@ -35,7 +38,7 @@
 -- @return ShuffleTiles#ShuffleTiles ret (return value: cc.ShuffleTiles)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#ShuffleTiles] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/SimpleAudioEngine.lua

@@ -4,18 +4,18 @@
 -- @parent_module cc
 
 --------------------------------
--- brief Preload background music<br>
--- param pszFilePath The path of the background music file.<br>
+-- Preload background music.<br>
+-- param filePath The path of the background music file.<br>
 -- js preloadMusic<br>
 -- lua preloadMusic
 -- @function [parent=#SimpleAudioEngine] preloadBackgroundMusic 
 -- @param self
--- @param #char pszFilePath
+-- @param #char filePath
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Stop playing background music<br>
--- param bReleaseData If release the background music data or not.As default value is false<br>
+-- Stop playing background music.<br>
+-- param releaseData If release the background music data or not.As default value is false.<br>
 -- js stopMusic<br>
 -- lua stopMusic
 -- @function [parent=#SimpleAudioEngine] stopBackgroundMusic 
@@ -23,13 +23,13 @@
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Stop all playing sound effects
+-- Stop all playing sound effects.
 -- @function [parent=#SimpleAudioEngine] stopAllEffects 
 -- @param self
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief The volume of the background music within the range of 0.0 as the minimum and 1.0 as the maximum.<br>
+-- The volume of the background music within the range of 0.0 as the minimum and 1.0 as the maximum.<br>
 -- js getMusicVolume<br>
 -- lua getMusicVolume
 -- @function [parent=#SimpleAudioEngine] getBackgroundMusicVolume 
@@ -37,7 +37,7 @@
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- brief Resume playing background music<br>
+-- Resume playing background music.<br>
 -- js resumeMusic<br>
 -- lua resumeMusic
 -- @function [parent=#SimpleAudioEngine] resumeBackgroundMusic 
@@ -45,7 +45,7 @@
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Set the volume of background music<br>
+-- Set the volume of background music.<br>
 -- param volume must be within the range of 0.0 as the minimum and 1.0 as the maximum.<br>
 -- js setMusicVolume<br>
 -- lua setMusicVolume
@@ -55,17 +55,17 @@
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief          preload a compressed audio file<br>
--- details        the compressed audio will be decoded to wave, then written into an internal buffer in SimpleAudioEngine<br>
--- param pszFilePath The path of the effect file
+-- Preload a compressed audio file.<br>
+-- The compressed audio will be decoded to wave, then written into an internal buffer in SimpleAudioEngine.<br>
+-- param filePath The path of the effect file.
 -- @function [parent=#SimpleAudioEngine] preloadEffect 
 -- @param self
--- @param #char pszFilePath
+-- @param #char filePath
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Indicates whether the background music is playing<br>
--- return <i>true</i> if the background music is playing, otherwise <i>false</i><br>
+-- Indicates whether the background music is playing.<br>
+-- return <i>true</i> if the background music is playing, otherwise <i>false</i>.<br>
 -- js isMusicPlaying<br>
 -- lua isMusicPlaying
 -- @function [parent=#SimpleAudioEngine] isBackgroundMusicPlaying 
@@ -73,13 +73,13 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- brief The volume of the effects within the range of 0.0 as the minimum and 1.0 as the maximum.
+-- The volume of the effects within the range of 0.0 as the minimum and 1.0 as the maximum.
 -- @function [parent=#SimpleAudioEngine] getEffectsVolume 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- brief Indicates whether any background music can be played or not.<br>
+-- Indicates whether any background music can be played or not.<br>
 -- return <i>true</i> if background music can be played, otherwise <i>false</i>.<br>
 -- js willPlayMusic<br>
 -- lua willPlayMusic
@@ -88,35 +88,35 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- brief Pause playing sound effect<br>
--- param nSoundId The return value of function playEffect
+-- Pause playing sound effect.<br>
+-- param soundId The return value of function playEffect.
 -- @function [parent=#SimpleAudioEngine] pauseEffect 
 -- @param self
--- @param #unsigned int nSoundId
+-- @param #unsigned int soundId
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Play sound effect with a file path, pitch, pan and gain<br>
--- param pszFilePath The path of the effect file.<br>
--- param bLoop Determines whether to loop the effect playing or not. The default value is false.<br>
+-- Play sound effect with a file path, pitch, pan and gain.<br>
+-- param filePath The path of the effect file.<br>
+-- param loop Determines whether to loop the effect playing or not. The default value is false.<br>
 -- param pitch Frequency, normal value is 1.0. Will also change effect play time.<br>
 -- param pan   Stereo effect, in the range of [-1..1] where -1 enables only left channel.<br>
 -- param gain  Volume, in the range of [0..1]. The normal value is 1.<br>
--- return the OpenAL source id<br>
+-- return The sound id.<br>
 -- note Full support is under development, now there are limitations:<br>
 -- - no pitch effect on Samsung Galaxy S2 with OpenSL backend enabled;<br>
--- - no pitch/pan/gain on emscrippten, win32, marmalade.
+-- - no pitch/pan/gain on win32.
 -- @function [parent=#SimpleAudioEngine] playEffect 
 -- @param self
--- @param #char pszFilePath
--- @param #bool bLoop
+-- @param #char filePath
+-- @param #bool loop
 -- @param #float pitch
 -- @param #float pan
 -- @param #float gain
 -- @return unsigned int#unsigned int ret (return value: unsigned int)
         
 --------------------------------
--- brief Rewind playing background music<br>
+-- Rewind playing background music.<br>
 -- js rewindMusic<br>
 -- lua rewindMusic
 -- @function [parent=#SimpleAudioEngine] rewindBackgroundMusic 
@@ -124,25 +124,25 @@
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Play background music<br>
--- param pszFilePath The path of the background music file,or the FileName of T_SoundResInfo<br>
--- param bLoop Whether the background music loop or not<br>
+-- Play background music.<br>
+-- param filePath The path of the background music file,or the FileName of T_SoundResInfo.<br>
+-- param loop Whether the background music loop or not.<br>
 -- js playMusic<br>
 -- lua playMusic
 -- @function [parent=#SimpleAudioEngine] playBackgroundMusic 
 -- @param self
--- @param #char pszFilePath
--- @param #bool bLoop
+-- @param #char filePath
+-- @param #bool loop
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Resume all playing sound effect
+-- Resume all playing sound effect.
 -- @function [parent=#SimpleAudioEngine] resumeAllEffects 
 -- @param self
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Set the volume of sound effects<br>
+-- Set the volume of sound effects.<br>
 -- param volume must be within the range of 0.0 as the minimum and 1.0 as the maximum.
 -- @function [parent=#SimpleAudioEngine] setEffectsVolume 
 -- @param self
@@ -150,15 +150,15 @@
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Stop playing sound effect<br>
--- param nSoundId The return value of function playEffect
+-- Stop playing sound effect.<br>
+-- param soundId The return value of function playEffect.
 -- @function [parent=#SimpleAudioEngine] stopEffect 
 -- @param self
--- @param #unsigned int nSoundId
+-- @param #unsigned int soundId
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Pause playing background music<br>
+-- Pause playing background music.<br>
 -- js pauseMusic<br>
 -- lua pauseMusic
 -- @function [parent=#SimpleAudioEngine] pauseBackgroundMusic 
@@ -166,36 +166,36 @@
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Pause all playing sound effect
+-- Pause all playing sound effect.
 -- @function [parent=#SimpleAudioEngine] pauseAllEffects 
 -- @param self
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief          unload the preloaded effect from internal buffer<br>
--- param pszFilePath        The path of the effect file
+-- Unload the preloaded effect from internal buffer.<br>
+-- param filePath The path of the effect file.
 -- @function [parent=#SimpleAudioEngine] unloadEffect 
 -- @param self
--- @param #char pszFilePath
+-- @param #char filePath
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Resume playing sound effect<br>
--- param nSoundId The return value of function playEffect
+-- Resume playing sound effect.<br>
+-- param soundId The return value of function playEffect.
 -- @function [parent=#SimpleAudioEngine] resumeEffect 
 -- @param self
--- @param #unsigned int nSoundId
+-- @param #unsigned int soundId
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Release the shared Engine object<br>
--- warning It must be called before the application exit, or a memory leak will be casued.
+-- Release the shared Engine object.<br>
+-- warning It must be called before the application exit, or it will lead to memory leaks.
 -- @function [parent=#SimpleAudioEngine] end 
 -- @param self
 -- @return SimpleAudioEngine#SimpleAudioEngine self (return value: cc.SimpleAudioEngine)
         
 --------------------------------
--- brief Get the shared Engine object,it will new one when first time be called
+-- Returns a shared instance of the SimpleAudioEngine.
 -- @function [parent=#SimpleAudioEngine] getInstance 
 -- @param self
 -- @return SimpleAudioEngine#SimpleAudioEngine ret (return value: cc.SimpleAudioEngine)

cocos/scripting/lua-bindings/auto/api/Speed.lua

@@ -5,33 +5,39 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+--  Replace the interior action.<br>
+-- param action The new action, it will replace the running action.
 -- @function [parent=#Speed] setInnerAction 
 -- @param self
 -- @param #cc.ActionInterval action
 -- @return Speed#Speed self (return value: cc.Speed)
         
 --------------------------------
---  alter the speed of the inner function in runtime 
+--  Alter the speed of the inner function in runtime. <br>
+-- param speed Alter the speed of the inner function in runtime.
 -- @function [parent=#Speed] setSpeed 
 -- @param self
 -- @param #float speed
 -- @return Speed#Speed self (return value: cc.Speed)
         
 --------------------------------
--- 
+--  Return the interior action.<br>
+-- return The interior action.
 -- @function [parent=#Speed] getInnerAction 
 -- @param self
 -- @return ActionInterval#ActionInterval ret (return value: cc.ActionInterval)
         
 --------------------------------
--- 
+--  Return the speed.<br>
+-- return The action speed.
 -- @function [parent=#Speed] getSpeed 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  create the action 
+--  Create the action and set the speed.<br>
+-- param action An action.<br>
+-- param speed The action speed.
 -- @function [parent=#Speed] create 
 -- @param self
 -- @param #cc.ActionInterval action
@@ -71,7 +77,8 @@
 -- @return Speed#Speed self (return value: cc.Speed)
         
 --------------------------------
--- 
+--  Return true if the action has finished.<br>
+-- return Is true if the action has finished.
 -- @function [parent=#Speed] isDone 
 -- @param self
 -- @return bool#bool ret (return value: bool)

cocos/scripting/lua-bindings/auto/api/SplitCols.lua

@@ -5,8 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
--- creates the action with the number of columns to split and the duration <br>
--- param duration in seconds
+-- brief Create the action with the number of columns and the duration.<br>
+-- param duration Specify the duration of the SplitCols action. It's a value in seconds.<br>
+-- param cols Specify the columns count should be splited.<br>
+-- return If the creation success, return a pointer of SplitCols action; otherwise, return nil.
 -- @function [parent=#SplitCols] create 
 -- @param self
 -- @param #float duration

cocos/scripting/lua-bindings/auto/api/SplitRows.lua

@@ -5,8 +5,10 @@
 -- @parent_module cc
 
 --------------------------------
--- creates the action with the number of rows to split and the duration <br>
--- param duration in seconds
+-- brief Create the action with the number of rows and the duration.<br>
+-- param duration Specify the duration of the SplitRows action. It's a value in seconds.<br>
+-- param rows Specify the rows count should be splited.<br>
+-- return If the creation success, return a pointer of SplitRows action; otherwise, return nil.
 -- @function [parent=#SplitRows] create 
 -- @param self
 -- @param #float duration

cocos/scripting/lua-bindings/auto/api/StopGrid.lua

@@ -5,7 +5,8 @@
 -- @parent_module cc
 
 --------------------------------
---  Allocates and initializes the action 
+-- brief Create a StopGrid Action.<br>
+-- return Return a pointer of StopGrid. When the creation failed, return nil.
 -- @function [parent=#StopGrid] create 
 -- @param self
 -- @return StopGrid#StopGrid ret (return value: cc.StopGrid)

cocos/scripting/lua-bindings/auto/api/TurnOffTiles.lua

@@ -5,14 +5,16 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- brief Show the tile at specified position.<br>
+-- param pos The position index of the tile should be shown.
 -- @function [parent=#TurnOffTiles] turnOnTile 
 -- @param self
 -- @param #vec2_table pos
 -- @return TurnOffTiles#TurnOffTiles self (return value: cc.TurnOffTiles)
         
 --------------------------------
--- 
+-- brief Hide the tile at specified position.<br>
+-- param pos The position index of the tile should be hide.
 -- @function [parent=#TurnOffTiles] turnOffTile 
 -- @param self
 -- @param #vec2_table pos

cocos/scripting/lua-bindings/auto/api/Twirl.lua

@@ -5,46 +5,58 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- brief Set the ampliture rate of the effect.<br>
+-- param amplitudeRate The value of amplitude rate will be set.
 -- @function [parent=#Twirl] setAmplitudeRate 
 -- @param self
 -- @param #float amplitudeRate
 -- @return Twirl#Twirl self (return value: cc.Twirl)
         
 --------------------------------
--- 
+-- brief Get the amplitude rate of the effect.<br>
+-- return Return the amplitude rate of the effect.
 -- @function [parent=#Twirl] getAmplitudeRate 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Set the amplitude to the effect.<br>
+-- param amplitude The value of amplitude will be set.
 -- @function [parent=#Twirl] setAmplitude 
 -- @param self
 -- @param #float amplitude
 -- @return Twirl#Twirl self (return value: cc.Twirl)
         
 --------------------------------
--- 
+-- brief Get the amplitude of the effect.<br>
+-- return Return the amplitude of the effect.
 -- @function [parent=#Twirl] getAmplitude 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  set twirl center 
+-- brief Set the center position of twirl action.<br>
+-- param position The center position of twirl action will be set.
 -- @function [parent=#Twirl] setPosition 
 -- @param self
 -- @param #vec2_table position
 -- @return Twirl#Twirl self (return value: cc.Twirl)
         
 --------------------------------
---  get twirl center 
+-- brief Get the center position of twirl action.<br>
+-- return The center position of twirl action.
 -- @function [parent=#Twirl] getPosition 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
         
 --------------------------------
---  creates the action with center position, number of twirls, amplitude, a grid size and duration 
+-- brief Create the action with center position, number of twirls, amplitude, a grid size and duration.<br>
+-- param duration Specify the duration of the Twirl action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param position Specify the center position of the twirl action.<br>
+-- param twirls Specify the twirls count of the Twirl action.<br>
+-- param amplitude Specify the amplitude of the Twirl action.<br>
+-- return If the creation sucess, return a pointer of Twirl action; otherwise, return nil.
 -- @function [parent=#Twirl] create 
 -- @param self
 -- @param #float duration
@@ -61,7 +73,7 @@
 -- @return Twirl#Twirl ret (return value: cc.Twirl)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#Twirl] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/UserDefault.lua

@@ -4,11 +4,13 @@
 -- @parent_module cc
 
 --------------------------------
--- brief Set integer value by key.<br>
+-- Set integer value by key.<br>
+-- param key The key to set.<br>
+-- param value A integer value to set to the key.<br>
 -- js NA
 -- @function [parent=#UserDefault] setIntegerForKey 
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #int value
 -- @return UserDefault#UserDefault self (return value: cc.UserDefault)
         
@@ -17,7 +19,7 @@
 -- @overload self, char         
 -- @function [parent=#UserDefault] getFloatForKey
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #float defaultValue
 -- @return float#float ret (return value: float)
 
@@ -26,25 +28,29 @@
 -- @overload self, char         
 -- @function [parent=#UserDefault] getBoolForKey
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #bool defaultValue
 -- @return bool#bool ret (return value: bool)
 
 --------------------------------
--- brief Set double value by key.<br>
+-- Set double value by key.<br>
+-- param key The key to set.<br>
+-- param value A double value to set to the key.<br>
 -- js NA
 -- @function [parent=#UserDefault] setDoubleForKey 
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #double value
 -- @return UserDefault#UserDefault self (return value: cc.UserDefault)
         
 --------------------------------
--- brief Set float value by key.<br>
+-- Set float value by key.<br>
+-- param key The key to set.<br>
+-- param value A float value to set to the key.<br>
 -- js NA
 -- @function [parent=#UserDefault] setFloatForKey 
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #float value
 -- @return UserDefault#UserDefault self (return value: cc.UserDefault)
         
@@ -53,21 +59,23 @@
 -- @overload self, char         
 -- @function [parent=#UserDefault] getStringForKey
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #string defaultValue
 -- @return string#string ret (return value: string)
 
 --------------------------------
--- brief Set string value by key.<br>
+-- Set string value by key.<br>
+-- param key The key to set.<br>
+-- param value A string value to set to the key.<br>
 -- js NA
 -- @function [parent=#UserDefault] setStringForKey 
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #string value
 -- @return UserDefault#UserDefault self (return value: cc.UserDefault)
         
 --------------------------------
--- brief Save content to xml file<br>
+-- You should invoke this function to save values set by setXXXForKey().<br>
 -- js NA
 -- @function [parent=#UserDefault] flush 
 -- @param self
@@ -78,7 +86,7 @@
 -- @overload self, char         
 -- @function [parent=#UserDefault] getIntegerForKey
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #int defaultValue
 -- @return int#int ret (return value: int)
 
@@ -87,16 +95,18 @@
 -- @overload self, char         
 -- @function [parent=#UserDefault] getDoubleForKey
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #double defaultValue
 -- @return double#double ret (return value: double)
 
 --------------------------------
--- brief Set bool value by key.<br>
+-- Set bool value by key.<br>
+-- param key The key to set.<br>
+-- param value A bool value to set to the key.<br>
 -- js NA
 -- @function [parent=#UserDefault] setBoolForKey 
 -- @param self
--- @param #char pKey
+-- @param #char key
 -- @param #bool value
 -- @return UserDefault#UserDefault self (return value: cc.UserDefault)
         
@@ -107,12 +117,15 @@
 -- @return UserDefault#UserDefault self (return value: cc.UserDefault)
         
 --------------------------------
+--  All supported platforms other iOS & Android use xml file to save values. This function is return the file path of the xml path.<br>
 -- js NA
 -- @function [parent=#UserDefault] getXMLFilePath 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
+--  All supported platforms other iOS & Android use xml file to save values. This function checks whether the xml file exists or not.<br>
+-- return True if the xml file exists, flase if not.<br>
 -- js NA
 -- @function [parent=#UserDefault] isXMLFileExist 
 -- @param self

cocos/scripting/lua-bindings/auto/api/Waves.lua

@@ -5,33 +5,44 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- brief Get the amplitude rate of the effect.<br>
+-- return Return the amplitude rate of the effect.
 -- @function [parent=#Waves] getAmplitudeRate 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Set the amplitude to the effect.<br>
+-- param amplitude The value of amplitude will be set.
 -- @function [parent=#Waves] setAmplitude 
 -- @param self
 -- @param #float amplitude
 -- @return Waves#Waves self (return value: cc.Waves)
         
 --------------------------------
--- 
+-- brief Set the ampliture rate of the effect.<br>
+-- param amplitudeRate The value of amplitude rate will be set.
 -- @function [parent=#Waves] setAmplitudeRate 
 -- @param self
 -- @param #float amplitudeRate
 -- @return Waves#Waves self (return value: cc.Waves)
         
 --------------------------------
--- 
+-- brief Get the amplitude of the effect.<br>
+-- return Return the amplitude of the effect.
 -- @function [parent=#Waves] getAmplitude 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  initializes the action with amplitude, horizontal sin, vertical sin, a grid and duration 
+-- brief Create the action with amplitude, horizontal sin, vertical sin, grid size, waves count and duration.<br>
+-- param duration Specify the duration of the Waves action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param waves Specify the waves count of the Waves action.<br>
+-- param amplitude Specify the amplitude of the Waves action.<br>
+-- param horizontal Specify whether waves on horizontal.<br>
+-- param vertical Specify whether waves on vertical.<br>
+-- return If the creation sucess, return a pointer of Waves action; otherwise, return nil.
 -- @function [parent=#Waves] create 
 -- @param self
 -- @param #float duration
@@ -49,7 +60,7 @@
 -- @return Waves#Waves ret (return value: cc.Waves)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#Waves] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/Waves3D.lua

@@ -5,33 +5,42 @@
 -- @parent_module cc
 
 --------------------------------
---  returns the amplitude rate 
+-- brief Get the amplitude rate of the effect.<br>
+-- return Return the amplitude rate of the effect.
 -- @function [parent=#Waves3D] getAmplitudeRate 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  sets the amplitude to the effect 
+-- brief Set the amplitude to the effect.<br>
+-- param amplitude The value of amplitude will be set.
 -- @function [parent=#Waves3D] setAmplitude 
 -- @param self
 -- @param #float amplitude
 -- @return Waves3D#Waves3D self (return value: cc.Waves3D)
         
 --------------------------------
---  sets the ampliture rate 
+-- brief Set the ampliture rate of the effect.<br>
+-- param amplitudeRate The value of amplitude rate will be set.
 -- @function [parent=#Waves3D] setAmplitudeRate 
 -- @param self
 -- @param #float amplitudeRate
 -- @return Waves3D#Waves3D self (return value: cc.Waves3D)
         
 --------------------------------
---  returns the amplitude of the effect 
+-- brief Get the amplitude of the effect.<br>
+-- return Return the amplitude of the effect.
 -- @function [parent=#Waves3D] getAmplitude 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
---  creates an action with duration, grid size, waves and amplitude 
+-- brief Create an action with duration, grid size, waves and amplitude.<br>
+-- param duration Specify the duration of the Waves3D action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param waves Specify the waves count of the Waves3D action.<br>
+-- param amplitude Specify the amplitude of the Waves3D action.<br>
+-- return If the creation sucess, return a pointer of Waves3D action; otherwise, return nil.
 -- @function [parent=#Waves3D] create 
 -- @param self
 -- @param #float duration
@@ -47,7 +56,7 @@
 -- @return Waves3D#Waves3D ret (return value: cc.Waves3D)
         
 --------------------------------
--- param time in seconds
+-- 
 -- @function [parent=#Waves3D] update 
 -- @param self
 -- @param #float time

cocos/scripting/lua-bindings/auto/api/WavesTiles3D.lua

@@ -5,34 +5,42 @@
 -- @parent_module cc
 
 --------------------------------
---  waves amplitude rate 
+-- brief Get the amplitude rate of the effect.<br>
+-- return Return the amplitude rate of the effect.
 -- @function [parent=#WavesTiles3D] getAmplitudeRate 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Set the amplitude to the effect.<br>
+-- param amplitude The value of amplitude will be set.
 -- @function [parent=#WavesTiles3D] setAmplitude 
 -- @param self
 -- @param #float amplitude
 -- @return WavesTiles3D#WavesTiles3D self (return value: cc.WavesTiles3D)
         
 --------------------------------
--- 
+-- brief Set the ampliture rate of the effect.<br>
+-- param amplitudeRate The value of amplitude rate will be set.
 -- @function [parent=#WavesTiles3D] setAmplitudeRate 
 -- @param self
 -- @param #float amplitudeRate
 -- @return WavesTiles3D#WavesTiles3D self (return value: cc.WavesTiles3D)
         
 --------------------------------
---  waves amplitude 
+-- brief Get the amplitude of the effect.<br>
+-- return Return the amplitude of the effect.
 -- @function [parent=#WavesTiles3D] getAmplitude 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- creates the action with a number of waves, the waves amplitude, the grid size and the duration <br>
--- param duration in seconds
+-- brief Create the action with a number of waves, the waves amplitude, the grid size and the duration.<br>
+-- param duration Specify the duration of the WavesTiles3D action. It's a value in seconds.<br>
+-- param gridSize Specify the size of the grid.<br>
+-- param waves Specify the waves count of the WavesTiles3D action.<br>
+-- param amplitude Specify the amplitude of the WavesTiles3D action.<br>
+-- return If the creation success, return a pointer of WavesTiles3D action; otherwise, return nil.
 -- @function [parent=#WavesTiles3D] create 
 -- @param self
 -- @param #float duration
@@ -48,7 +56,7 @@
 -- @return WavesTiles3D#WavesTiles3D ret (return value: cc.WavesTiles3D)
         
 --------------------------------
--- param duration in seconds
+-- 
 -- @function [parent=#WavesTiles3D] update 
 -- @param self
 -- @param #float time