[AUTO]: updating luabinding automatically

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

@@ -5,28 +5,31 @@
 -- @parent_module ccui
 
 --------------------------------
--- 
+-- Query the button title content.<br>
+-- return Get the button's title content.
 -- @function [parent=#Button] getTitleText 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+-- Change the font size of button's title<br>
+-- param size Title font size in float.
 -- @function [parent=#Button] setTitleFontSize 
 -- @param self
 -- @param #float size
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- Sets if button is using scale9 renderer.<br>
+-- Enable scale9 renderer.<br>
--- param true that using scale9 renderer, false otherwise.
+-- param enable Set to true will use scale9 renderer, false otherwise.
 -- @function [parent=#Button] setScale9Enabled 
 -- @param self
--- @param #bool able
+-- @param #bool enable
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- Return the inner title renderer of Button<br>
+-- Return the inner title renderer of Button.<br>
+-- return The button title.<br>
 -- since v3.3
 -- @function [parent=#Button] getTitleRenderer 
 -- @param self
@@ -34,44 +37,48 @@
         
 --------------------------------
 -- brief Return a zoom scale <br>
+-- return the zoom scale in float<br>
 -- since v3.3
 -- @function [parent=#Button] getZoomScale 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Return the capInsets of disabled state scale9sprite.<br>
+-- return The disabled scale9 renderer capInsets.
 -- @function [parent=#Button] getCapInsetsDisabledRenderer 
 -- @param self
 -- @return rect_table#rect_table ret (return value: rect_table)
         
 --------------------------------
--- 
+-- Change the color of button's title.<br>
+-- param color The title color in Color3B.
 -- @function [parent=#Button] setTitleColor 
 -- @param self
 -- @param #color3b_table color
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- Sets capinsets for button, if button is using scale9 renderer.<br>
+-- Sets capInsets for button, only the disabled state scale9 renderer will be affected.<br>
--- param capInsets    capinsets for button
+-- param capInsets  capInsets in Rect.
 -- @function [parent=#Button] setCapInsetsDisabledRenderer 
 -- @param self
 -- @param #rect_table capInsets
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- Sets capinsets for button, if button is using scale9 renderer.<br>
+-- Sets capInsets for button.<br>
--- param capInsets    capinsets for button
+-- The capInset affects  all button scale9 renderer only if `setScale9Enabled(true)` is called<br>
+-- param capInsets    capInset in Rect.
 -- @function [parent=#Button] setCapInsets 
 -- @param self
 -- @param #rect_table capInsets
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- Load dark state texture for button.<br>
+-- Load disabled state texture for button.<br>
 -- param disabled    dark state texture.<br>
--- param texType    @see TextureResType
+-- param texType    @see `TextureResType`
 -- @function [parent=#Button] loadTextureDisabled 
 -- @param self
 -- @param #string disabled
@@ -79,15 +86,16 @@
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- 
+-- Change the content of button's title.<br>
+-- param text The title in std::string.
 -- @function [parent=#Button] setTitleText 
 -- @param self
 -- @param #string text
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- Sets capinsets for button, if button is using scale9 renderer.<br>
+-- Sets capInsets for button, only the normal state scale9 renderer will be affected.<br>
--- param capInsets    capinsets for button
+-- param capInsets    capInsets in Rect.
 -- @function [parent=#Button] setCapInsetsNormalRenderer 
 -- @param self
 -- @param #rect_table capInsets
@@ -96,7 +104,7 @@
 --------------------------------
 -- Load selected state texture for button.<br>
 -- param selected    selected state texture.<br>
--- param texType    @see TextureResType
+-- param texType    @see `TextureResType`
 -- @function [parent=#Button] loadTexturePressed 
 -- @param self
 -- @param #string selected
@@ -104,20 +112,23 @@
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- 
+-- Change the font name of button's title<br>
+-- param fontName a font name string.
 -- @function [parent=#Button] setTitleFontName 
 -- @param self
 -- @param #string fontName
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- 
+-- Return the capInsets of normal state scale9sprite.<br>
+-- return The normal scale9 renderer capInsets.
 -- @function [parent=#Button] getCapInsetsNormalRenderer 
 -- @param self
 -- @return rect_table#rect_table ret (return value: rect_table)
         
 --------------------------------
--- 
+-- Return the capInsets of pressed state scale9sprite.<br>
+-- return The pressed scale9 renderer capInsets.
 -- @function [parent=#Button] getCapInsetsPressedRenderer 
 -- @param self
 -- @return rect_table#rect_table ret (return value: rect_table)
@@ -127,7 +138,7 @@
 -- param normal    normal state texture name.<br>
 -- param selected    selected state texture name.<br>
 -- param disabled    disabled state texture name.<br>
--- param texType    @see TextureResType
+-- param texType    @see `TextureResType`
 -- @function [parent=#Button] loadTextures 
 -- @param self
 -- @param #string normal
@@ -137,7 +148,8 @@
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- 
+-- Query whether button is using scale9 renderer or not.<br>
+-- return whether button use scale9 renderer or not.
 -- @function [parent=#Button] isScale9Enabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
@@ -145,7 +157,7 @@
 --------------------------------
 -- Load normal state texture for button.<br>
 -- param normal    normal state texture.<br>
--- param texType    @see TextureResType
+-- param texType    @see `TextureResType`
 -- @function [parent=#Button] loadTextureNormal 
 -- @param self
 -- @param #string normal
@@ -153,41 +165,44 @@
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- Sets capinsets for button, if button is using scale9 renderer.<br>
+-- Sets capInsets for button, only the pressed state scale9 renderer will be affected.<br>
--- param capInsets    capinsets for button
+-- param capInsets    capInsets in Rect
 -- @function [parent=#Button] setCapInsetsPressedRenderer 
 -- @param self
 -- @param #rect_table capInsets
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- 
+-- Query the font size of button title<br>
+-- return font size in float.
 -- @function [parent=#Button] getTitleFontSize 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Query the font name of button's title<br>
+-- return font name in std::string
 -- @function [parent=#Button] getTitleFontName 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+-- Query the button title color.<br>
+-- return Color3B of button title.
 -- @function [parent=#Button] getTitleColor 
 -- @param self
 -- @return color3b_table#color3b_table ret (return value: color3b_table)
         
 --------------------------------
--- Changes if button can be clicked zoom effect.<br>
+-- Enable zooming action when button is pressed.<br>
--- param true that can be clicked zoom effect, false otherwise.
+-- param enabled Set to true will enable zoom effect, false otherwise.
 -- @function [parent=#Button] setPressedActionEnabled 
 -- @param self
 -- @param #bool enabled
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
---  When user pressed the button, the button will zoom to a scale.<br>
+--  @brief When user pressed the button, the button will zoom to a scale.<br>
 -- The final scale of the button  equals (button original scale + _zoomScale)<br>
 -- since v3.3
 -- @function [parent=#Button] setZoomScale 
@@ -219,7 +234,7 @@
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
--- Returns the "class name" of widget.
+-- 
 -- @function [parent=#Button] getDescription 
 -- @param self
 -- @return string#string ret (return value: string)
@@ -238,7 +253,7 @@
 -- @return Button#Button self (return value: ccui.Button)
         
 --------------------------------
--- Default constructor
+-- Default constructor.
 -- @function [parent=#Button] Button 
 -- @param self
 -- @return Button#Button self (return value: ccui.Button)

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

@@ -5,9 +5,9 @@
 -- @parent_module ccui
 
 --------------------------------
--- Load backGroundSelected texture for checkbox.<br>
+-- Load background selected state texture for checkbox.<br>
--- param backGroundSelected     backGround selected state texture.<br>
+-- param backGroundSelected    The background selected state image name.<br>
--- param texType    @see TextureResType
+-- param texType    @see `Widget::TextureResType`
 -- @function [parent=#CheckBox] loadTextureBackGroundSelected 
 -- @param self
 -- @param #string backGroundSelected
@@ -15,9 +15,9 @@
 -- @return CheckBox#CheckBox self (return value: ccui.CheckBox)
         
 --------------------------------
--- Load backGroundDisabled texture for checkbox.<br>
+-- Load background disabled state texture for checkbox.<br>
--- param backGroundDisabled    backGroundDisabled texture.<br>
+-- param backGroundDisabled    The background disabled state texture name.<br>
--- param texType    @see TextureResType
+-- param texType    @see `Widget::TextureResType`
 -- @function [parent=#CheckBox] loadTextureBackGroundDisabled 
 -- @param self
 -- @param #string backGroundDisabled
@@ -25,14 +25,17 @@
 -- @return CheckBox#CheckBox self (return value: ccui.CheckBox)
         
 --------------------------------
--- 
+-- Change CheckBox state.<br>
+-- Set to true will cause the CheckBox's state to "selected", false otherwise.<br>
+-- param selected Set to true will change CheckBox to selected state, false otherwise.
 -- @function [parent=#CheckBox] setSelected 
 -- @param self
 -- @param #bool selected
 -- @return CheckBox#CheckBox self (return value: ccui.CheckBox)
         
 --------------------------------
--- 
+-- Add a callback function which would be called when checkbox is selected or unselected.<br>
+-- param callback A std::function with type @see `ccCheckBoxCallback`
 -- @function [parent=#CheckBox] addEventListener 
 -- @param self
 -- @param #function callback
@@ -40,8 +43,8 @@
         
 --------------------------------
 -- Load cross texture for checkbox.<br>
--- param cross    cross texture.<br>
+-- param cross    The cross texture name.<br>
--- param texType    @see TextureResType
+-- param texType    @see `Widget::TextureResType`
 -- @function [parent=#CheckBox] loadTextureFrontCross 
 -- @param self
 -- @param #string 
@@ -49,18 +52,19 @@
 -- @return CheckBox#CheckBox self (return value: ccui.CheckBox)
         
 --------------------------------
--- 
+-- Query whether CheckBox is selected or not.<br>
+-- return true means "selected", false otherwise.
 -- @function [parent=#CheckBox] isSelected 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- Load textures for checkbox.<br>
+-- Load all textures for initializing a checkbox.<br>
--- param backGround    backGround texture.<br>
+-- param backGround    The background image name.<br>
--- param backGroundSelected    backGround selected state texture.<br>
+-- param backGroundSelected    The background selected image name.<br>
--- param cross    cross texture.<br>
+-- param cross    The cross image name.<br>
--- param frontCrossDisabled    cross dark state texture.<br>
+-- param frontCrossDisabled    The front cross disabled state image name.<br>
--- param texType    @see TextureResType
+-- param texType    @see `Widget::TextureResType`
 -- @function [parent=#CheckBox] loadTextures 
 -- @param self
 -- @param #string backGround
@@ -73,15 +77,16 @@
         
 --------------------------------
 -- brief Return a zoom scale<br>
+-- return A zoom scale of Checkbox.<br>
 -- since v3.3
 -- @function [parent=#CheckBox] getZoomScale 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- Load backGround texture for checkbox.<br>
+-- Load background texture for checkbox.<br>
--- param backGround    backGround texture.<br>
+-- param backGround   The background image name.<br>
--- param texType    @see TextureResType
+-- param texType    @see `Widget::TextureResType`
 -- @function [parent=#CheckBox] loadTextureBackGround 
 -- @param self
 -- @param #string backGround
@@ -89,8 +94,8 @@
 -- @return CheckBox#CheckBox self (return value: ccui.CheckBox)
         
 --------------------------------
---  When user pressed the button, the button will zoom to a scale.<br>
+--  When user pressed the CheckBox, the button will zoom to a scale.<br>
--- The final scale of the button  equals (button original scale + _zoomScale)<br>
+-- The final scale of the CheckBox  equals (CheckBox original scale + _zoomScale)<br>
 -- since v3.3
 -- @function [parent=#CheckBox] setZoomScale 
 -- @param self
@@ -98,9 +103,9 @@
 -- @return CheckBox#CheckBox self (return value: ccui.CheckBox)
         
 --------------------------------
--- Load frontCrossDisabled texture for checkbox.<br>
+-- Load frontcross disabled texture for checkbox.<br>
--- param frontCrossDisabled    frontCrossDisabled texture.<br>
+-- param frontCrossDisabled    The front cross disabled state texture name.<br>
--- param texType    @see TextureResType
+-- param texType    @see `Widget::TextureResType`
 -- @function [parent=#CheckBox] loadTextureFrontCrossDisabled 
 -- @param self
 -- @param #string frontCrossDisabled
@@ -134,7 +139,7 @@
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
--- Returns the "class name" of widget.
+-- 
 -- @function [parent=#CheckBox] getDescription 
 -- @param self
 -- @return string#string ret (return value: string)
@@ -146,7 +151,7 @@
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
--- Default constructor
+-- Default constructor.
 -- @function [parent=#CheckBox] CheckBox 
 -- @param self
 -- @return CheckBox#CheckBox self (return value: ccui.CheckBox)

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

@@ -173,7 +173,7 @@
 -- @function [parent=#EditBox] initWithSizeAndBackgroundSprite
 -- @param self
 -- @param #size_table size
--- @param #string pNormal9SpriteBg
+-- @param #string normal9SpriteBg
 -- @param #int texType
 -- @return bool#bool ret (return value: bool)
 

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

@@ -17,14 +17,19 @@
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+-- Change the active property of Layout's @see `LayoutComponent`<br>
+-- param active A boolean value.
 -- @function [parent=#Helper] changeLayoutSystemActiveState 
 -- @param self
--- @param #bool bActive
+-- @param #bool active
 -- @return Helper#Helper self (return value: ccui.Helper)
         
 --------------------------------
--- 
+-- Find a widget with a specific action tag from root widget<br>
+-- This search will be recursive throught all child widgets.<br>
+-- param root The be searched root widget.<br>
+-- param tag The widget action's tag.<br>
+-- return Widget instance pointer.
 -- @function [parent=#Helper] seekActionWidgetByActionTag 
 -- @param self
 -- @param #ccui.Widget root
@@ -32,10 +37,11 @@
 -- @return Widget#Widget ret (return value: ccui.Widget)
         
 --------------------------------
--- Finds a widget whose name equals to param name from root widget.<br>
+-- Find a widget with a specific name from root widget.<br>
--- param root      widget which will be seeked.<br>
+-- This search will be recursive throught all child widgets.<br>
--- name             name value.<br>
+-- param root      The be searched root widget.<br>
--- return finded result.
+-- param name      The widget name.<br>
+-- return Widget isntance pointer.
 -- @function [parent=#Helper] seekWidgetByName 
 -- @param self
 -- @param #ccui.Widget root
@@ -43,10 +49,11 @@
 -- @return Widget#Widget ret (return value: ccui.Widget)
         
 --------------------------------
--- Finds a widget whose tag equals to param tag from root widget.<br>
+-- Find a widget with a specific tag from root widget.<br>
--- param root      widget which will be seeked.<br>
+-- This search will be recursive throught all child widgets.<br>
--- tag             tag value.<br>
+-- param root      The be seached root widget.<br>
--- return finded result.
+-- param tag       The widget tag.<br>
+-- return Widget instance pointer.
 -- @function [parent=#Helper] seekWidgetByTag 
 -- @param self
 -- @param #ccui.Widget root
@@ -67,7 +74,7 @@
         
 --------------------------------
 -- Refresh object and it's children layout state<br>
--- param rootNode   object which will be changed
+-- param rootNode   A Node* or Node* descendant instance pointer.
 -- @function [parent=#Helper] doLayout 
 -- @param self
 -- @param #cc.Node rootNode

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

@@ -7,7 +7,7 @@
 --------------------------------
 -- Load texture for imageview.<br>
 -- param fileName   file name of texture.<br>
--- param texType    @see TextureResType
+-- param texType    @see `Widget::TextureResType`
 -- @function [parent=#ImageView] loadTexture 
 -- @param self
 -- @param #string fileName
@@ -15,8 +15,8 @@
 -- @return ImageView#ImageView self (return value: ccui.ImageView)
         
 --------------------------------
--- Sets if imageview is using scale9 renderer.<br>
+-- Enable scale9 renderer.<br>
--- param able true that using scale9 renderer, false otherwise.
+-- param enable Set to true will use scale9 renderer, false otherwise.
 -- @function [parent=#ImageView] setScale9Enabled 
 -- @param self
 -- @param #bool able
@@ -31,7 +31,8 @@
 -- @return ImageView#ImageView self (return value: ccui.ImageView)
         
 --------------------------------
--- Sets capinsets for imageview, if imageview is using scale9 renderer.<br>
+-- Sets capInsets for imageview.<br>
+-- The capInsets affects the ImageView's renderer only if `setScale9Enabled(true)` is called.<br>
 -- param capInsets    capinsets for imageview
 -- @function [parent=#ImageView] setCapInsets 
 -- @param self
@@ -39,13 +40,16 @@
 -- @return ImageView#ImageView self (return value: ccui.ImageView)
         
 --------------------------------
--- 
+-- Get ImageView's capInsets size.<br>
+-- return Query capInsets size in Rect<br>
+-- see `setCapInsets(const Rect&)`
 -- @function [parent=#ImageView] getCapInsets 
 -- @param self
 -- @return rect_table#rect_table ret (return value: rect_table)
         
 --------------------------------
--- 
+-- Query whether button is using scale9 renderer or not.<br>
+-- return whether button use scale9 renderer or not.
 -- @function [parent=#ImageView] isScale9Enabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
@@ -72,7 +76,7 @@
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
--- Returns the "class name" of widget.
+-- 
 -- @function [parent=#ImageView] getDescription 
 -- @param self
 -- @return string#string ret (return value: string)

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

@@ -5,23 +5,27 @@
 -- @parent_module ccui
 
 --------------------------------
--- Sets background color vector for layout, if color type is BackGroundColorType::GRADIENT<br>
+-- Sets background color vector for layout.<br>
--- param vector
+-- This setting only take effect when layout's color type is BackGroundColorType::GRADIENT<br>
+-- param vector The color vector in `Vec2`.
 -- @function [parent=#Layout] setBackGroundColorVector 
 -- @param self
 -- @param #vec2_table vector
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Change the clipping type of layout.<br>
+-- On default, the clipping type is `ClippingType::STENCIL`.<br>
+-- see `ClippingType`<br>
+-- param type The clipping type of layout.
 -- @function [parent=#Layout] setClippingType 
 -- @param self
 -- @param #int type
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- Sets Color Type for layout.<br>
+-- Sets Color Type for layout's background<br>
--- param type   @see LayoutBackGroundColorType.
+-- param type   @see `BackGroundColorType`
 -- @function [parent=#Layout] setBackGroundColorType 
 -- @param self
 -- @param #int type
@@ -36,20 +40,22 @@
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Set layout's background image color.<br>
+-- param color Background color value in `Color3B`.
 -- @function [parent=#Layout] setBackGroundImageColor 
 -- @param self
 -- @param #color3b_table color
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Get the layout's background color vector.<br>
+-- return Background color vector.
 -- @function [parent=#Layout] getBackGroundColorVector 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
         
 --------------------------------
--- 
+-- see `setClippingType(ClippingType)`
 -- @function [parent=#Layout] getClippingType 
 -- @param self
 -- @return int#int ret (return value: int)
@@ -67,7 +73,8 @@
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Get the layout's background color opacity.<br>
+-- return Background color opacity value.
 -- @function [parent=#Layout] getBackGroundColorOpacity 
 -- @param self
 -- @return unsigned char#unsigned char ret (return value: unsigned char)
@@ -80,16 +87,17 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Set opacity of background image.<br>
+-- param opacity Background image opacity in GLubyte.
 -- @function [parent=#Layout] setBackGroundImageOpacity 
 -- @param self
 -- @param #unsigned char opacity
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- Sets a background image for layout<br>
+-- Sets a background image for layout.<br>
 -- param fileName image file path.<br>
--- param texType @see TextureResType. TextureResType::LOCAL means local file, TextureResType::PLIST means sprite frame.
+-- param texType @see TextureResType. 
 -- @function [parent=#Layout] setBackGroundImage 
 -- @param self
 -- @param #string fileName
@@ -112,60 +120,67 @@
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Query background image's capInsets size.<br>
+-- return The background image capInsets.
 -- @function [parent=#Layout] getBackGroundImageCapInsets 
 -- @param self
 -- @return rect_table#rect_table ret (return value: rect_table)
         
 --------------------------------
--- 
+-- Query the layout's background color.<br>
+-- return Background color in Color3B.
 -- @function [parent=#Layout] getBackGroundColor 
 -- @param self
 -- @return color3b_table#color3b_table ret (return value: color3b_table)
         
 --------------------------------
--- Changes if layout can clip it's content and child.<br>
+-- Toggle layout clipping.<br>
--- If you really need this, please enable it. But it would reduce the rendering efficiency. <br>
+-- If you do need clipping, you pass true to this function.<br>
--- param clipping enabled.
+-- param enabled Pass true to enable clipping, false otherwise.
 -- @function [parent=#Layout] setClippingEnabled 
 -- @param self
 -- @param #bool enabled
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Get color of layout's background image.<br>
+-- return Layout's background image color.
 -- @function [parent=#Layout] getBackGroundImageColor 
 -- @param self
 -- @return color3b_table#color3b_table ret (return value: color3b_table)
         
 --------------------------------
--- 
+-- Query background image scale9 enable status.<br>
+-- return Whehter background image is scale9 enabled or not.
 -- @function [parent=#Layout] isBackGroundImageScale9Enabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Query the layout's background color type.<br>
+-- return The layout's background color type.
 -- @function [parent=#Layout] getBackGroundColorType 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- Get the gradient background end color.<br>
+-- return Gradient background end color value.
 -- @function [parent=#Layout] getBackGroundEndColor 
 -- @param self
 -- @return color3b_table#color3b_table ret (return value: color3b_table)
         
 --------------------------------
--- Sets background opacity layout.<br>
+-- Sets background color opacity of layout.<br>
--- param opacity
+-- param opacity The opacity in `GLubyte`.
 -- @function [parent=#Layout] setBackGroundColorOpacity 
 -- @param self
 -- @param #unsigned char opacity
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Get the opacity of layout's background image.<br>
+-- return The opacity of layout's background image.
 -- @function [parent=#Layout] getBackGroundImageOpacity 
 -- @param self
 -- @return unsigned char#unsigned char ret (return value: unsigned char)
@@ -177,8 +192,8 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- Sets a background image capinsets for layout, if the background image is a scale9 render.<br>
+-- Sets a background image capinsets for layout, it only affects the scale9 enabled background image<br>
--- param capinsets of background image.
+-- param capInsets  The capInsets in Rect.
 -- @function [parent=#Layout] setBackGroundImageCapInsets 
 -- @param self
 -- @param #rect_table capInsets
@@ -198,7 +213,8 @@
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Query layout type.<br>
+-- return Get the layout type.
 -- @function [parent=#Layout] getLayoutType 
 -- @param self
 -- @return int#int ret (return value: int)
@@ -211,28 +227,30 @@
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Get the gradient background start color.<br>
+-- return  Gradient background start color value.
 -- @function [parent=#Layout] getBackGroundStartColor 
 -- @param self
 -- @return color3b_table#color3b_table ret (return value: color3b_table)
         
 --------------------------------
--- Sets background iamge use scale9 renderer.<br>
+-- Enable background image scale9 rendering.<br>
--- param enabled   true that use scale9 renderer, false otherwise.
+-- param enabled  True means enable scale9 rendering for background image, false otherwise.
 -- @function [parent=#Layout] setBackGroundImageScale9Enabled 
 -- @param self
 -- @param #bool enabled
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- 
+-- Change the layout type.<br>
+-- param type Layout type.
 -- @function [parent=#Layout] setLayoutType 
 -- @param self
 -- @param #int type
 -- @return Layout#Layout self (return value: ccui.Layout)
         
 --------------------------------
--- Allocates and initializes a layout.
+-- Create a empty layout.
 -- @function [parent=#Layout] create 
 -- @param self
 -- @return Layout#Layout ret (return value: ccui.Layout)

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

@@ -5,319 +5,371 @@
 -- @parent_module ccui
 
 --------------------------------
--- 
+-- Toggle enable stretch width.<br>
+-- param isUsed True if enable stretch width, false otherwise.
 -- @function [parent=#LayoutComponent] setStretchWidthEnabled 
 -- @param self
 -- @param #bool isUsed
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Change percent width of owner.<br>
+-- param percentWidth Percent Width in float.
 -- @function [parent=#LayoutComponent] setPercentWidth 
 -- @param self
 -- @param #float percentWidth
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query the anchor position.<br>
+-- return Anchor position to it's parent
 -- @function [parent=#LayoutComponent] getAnchorPosition 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
         
 --------------------------------
--- 
+-- Toggle position percentX enabled.<br>
+-- param isUsed  True if enable position percentX, false otherwise.
 -- @function [parent=#LayoutComponent] setPositionPercentXEnabled 
 -- @param self
 -- @param #bool isUsed
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Toggle enable stretch height.<br>
+-- param isUsed True if stretch height is enabled, false otherwise.
 -- @function [parent=#LayoutComponent] setStretchHeightEnabled 
 -- @param self
 -- @param #bool isUsed
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Toggle active enabled of LayoutComponent's owner.<br>
+-- param enable True if active layout component, false otherwise.
 -- @function [parent=#LayoutComponent] setActiveEnabled 
 -- @param self
 -- @param #bool enable
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query the right margin of owner relative to its parent.<br>
+-- return Right margin in float.
 -- @function [parent=#LayoutComponent] getRightMargin 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Query owner's content size.<br>
+-- return Owner's content size.
 -- @function [parent=#LayoutComponent] getSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
--- 
+-- Change the anchor position to it's parent.<br>
+-- param point A value in (x,y) format.
 -- @function [parent=#LayoutComponent] setAnchorPosition 
 -- @param self
 -- @param #vec2_table point
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Refresh layout of the owner.
 -- @function [parent=#LayoutComponent] refreshLayout 
 -- @param self
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query whether percent width is enabled or not.<br>
+-- return True if percent width is enabled, false, otherwise.
 -- @function [parent=#LayoutComponent] isPercentWidthEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Change element's vertical dock type.<br>
+-- param vEage Vertical dock type @see `VerticalEdge`.
 -- @function [parent=#LayoutComponent] setVerticalEdge 
 -- @param self
 -- @param #int vEage
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query the top margin of owner relative to its parent.<br>
+-- return Top margin in float.
 -- @function [parent=#LayoutComponent] getTopMargin 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Change content size width of owner.<br>
+-- param width Content size width in float.
 -- @function [parent=#LayoutComponent] setSizeWidth 
 -- @param self
 -- @param #float width
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query the percent content size value.<br>
+-- return Percet (x,y) in Vec2.
 -- @function [parent=#LayoutComponent] getPercentContentSize 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
         
 --------------------------------
--- 
+-- Query element vertical dock type.<br>
+-- return Vertical dock type.
 -- @function [parent=#LayoutComponent] getVerticalEdge 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- Toggle enable percent width.<br>
+-- param isUsed True if percent width is enabled, false otherwise.
 -- @function [parent=#LayoutComponent] setPercentWidthEnabled 
 -- @param self
 -- @param #bool isUsed
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query whether stretch width is enabled or not.<br>
+-- return True if stretch width is enabled, false otherwise.
 -- @function [parent=#LayoutComponent] isStretchWidthEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Change left margin of owner relative to its parent.<br>
+-- param margin Margin in float.
 -- @function [parent=#LayoutComponent] setLeftMargin 
 -- @param self
 -- @param #float margin
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query content size width of owner.<br>
+-- return Content size width in float.
 -- @function [parent=#LayoutComponent] getSizeWidth 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Toggle position percentY enabled.<br>
+-- param isUsed True if position percentY is enabled, false otherwise.
 -- @function [parent=#LayoutComponent] setPositionPercentYEnabled 
 -- @param self
 -- @param #bool isUsed
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query size height of owner.<br>
+-- return Size height in float.
 -- @function [parent=#LayoutComponent] getSizeHeight 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Query the position percentY Y value.<br>
+-- return Position percent Y value in float.
 -- @function [parent=#LayoutComponent] getPositionPercentY 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Query the position percent X value.<br>
+-- return Position percent X value in float.
 -- @function [parent=#LayoutComponent] getPositionPercentX 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Change the top margin of owner relative to its parent.<br>
+-- param margin Margin in float.
 -- @function [parent=#LayoutComponent] setTopMargin 
 -- @param self
 -- @param #float margin
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query percent hieght of owner.         <br>
+-- return Percent height in float.
 -- @function [parent=#LayoutComponent] getPercentHeight 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Query whether use percent content size or not.<br>
+-- return True if using percent content size, false otherwise.
 -- @function [parent=#LayoutComponent] getUsingPercentContentSize 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Change position percentY value.<br>
+-- param percentMargin Margin in float.
 -- @function [parent=#LayoutComponent] setPositionPercentY 
 -- @param self
 -- @param #float percentMargin
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Change position percent X value.<br>
+-- param percentMargin Margin in float.
 -- @function [parent=#LayoutComponent] setPositionPercentX 
 -- @param self
 -- @param #float percentMargin
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Change right margin of owner relative to its parent.<br>
+-- param margin Margin in float.
 -- @function [parent=#LayoutComponent] setRightMargin 
 -- @param self
 -- @param #float margin
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Whether position percentY is enabled or not.<br>
+-- see `setPositionPercentYEnabled`<br>
+-- return True if position percentY is enabled, false otherwise.
 -- @function [parent=#LayoutComponent] isPositionPercentYEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Change percent height value of owner.<br>
+-- param percentHeight Percent height in float.
 -- @function [parent=#LayoutComponent] setPercentHeight 
 -- @param self
 -- @param #float percentHeight
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Toggle enable percent only.<br>
+-- param enable True if percent only is enabled, false otherwise.
 -- @function [parent=#LayoutComponent] setPercentOnlyEnabled 
 -- @param self
 -- @param #bool enable
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Change element's horizontal dock type.<br>
+-- param hEage Horizontal dock type @see `HorizontalEdge`
 -- @function [parent=#LayoutComponent] setHorizontalEdge 
 -- @param self
 -- @param #int hEage
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Change the position of component owner.<br>
+-- param position A position in (x,y)
 -- @function [parent=#LayoutComponent] setPosition 
 -- @param self
 -- @param #vec2_table position
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Percent content size is used to adapt node's content size based on parent's content size.<br>
+-- If set to true then node's content size will be changed based on the value setted by @setPercentContentSize<br>
+-- param isUsed True to enable percent content size, false otherwise.
 -- @function [parent=#LayoutComponent] setUsingPercentContentSize 
 -- @param self
 -- @param #bool isUsed
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query left margin of owner relative to its parent.<br>
+-- return Left margin in float.
 -- @function [parent=#LayoutComponent] getLeftMargin 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Query the owner's position.<br>
+-- return The owner's position.
 -- @function [parent=#LayoutComponent] getPosition 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
         
 --------------------------------
--- 
+-- Change size height of owner.<br>
+-- param height Size height in float.
 -- @function [parent=#LayoutComponent] setSizeHeight 
 -- @param self
 -- @param #float height
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Whether position percentX is enabled or not. <br>
+-- return True if position percertX is enable, false otherwise.
 -- @function [parent=#LayoutComponent] isPositionPercentXEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Query the bottom margin of owner relative to its parent.<br>
+-- return Bottom margin in float.
 -- @function [parent=#LayoutComponent] getBottomMargin 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Toggle enable percent height.<br>
+-- param isUsed True if percent height is enabled, false otherwise.
 -- @function [parent=#LayoutComponent] setPercentHeightEnabled 
 -- @param self
 -- @param #bool isUsed
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Set percent content size.<br>
+-- The value should be [0-1], 0 means the child's content size will be 0<br>
+-- and 1 means the child's content size is the same as its parents.<br>
+-- param percent The percent (x,y) of the node in [0-1] scope.
 -- @function [parent=#LayoutComponent] setPercentContentSize 
 -- @param self
 -- @param #vec2_table percent
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Query whehter percent height is enabled or not.<br>
+-- return True if percent height is enabled, false otherwise.
 -- @function [parent=#LayoutComponent] isPercentHeightEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Query percent width of owner.<br>
+-- return percent width in float.
 -- @function [parent=#LayoutComponent] getPercentWidth 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Query element horizontal dock type.<br>
+-- return Horizontal dock type.
 -- @function [parent=#LayoutComponent] getHorizontalEdge 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- Query whether stretch height is enabled or not.<br>
+-- return True if stretch height is enabled, false otherwise.
 -- @function [parent=#LayoutComponent] isStretchHeightEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Change the bottom margin of owner relative to its parent.<br>
+-- param Margin in float.
 -- @function [parent=#LayoutComponent] setBottomMargin 
 -- @param self
 -- @param #float margin
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Change the content size of owner.<br>
+-- param size Content size in @see `Size`.
 -- @function [parent=#LayoutComponent] setSize 
 -- @param self
 -- @param #size_table size
@@ -330,7 +382,11 @@
 -- @return LayoutComponent#LayoutComponent ret (return value: ccui.LayoutComponent)
         
 --------------------------------
--- 
+-- Bind a LayoutComponent to a specified node.<br>
+-- If the node has already binded a LayoutComponent named __LAYOUT_COMPONENT_NAME, just return the LayoutComponent.<br>
+-- Otherwise, create a new LayoutComponent and bind the LayoutComponent to the node.<br>
+-- param node A Node* instance pointer.<br>
+-- return The binded LayoutComponent instance pointer.
 -- @function [parent=#LayoutComponent] bindLayoutComponent 
 -- @param self
 -- @param #cc.Node node
@@ -343,7 +399,7 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Default constructor
 -- @function [parent=#LayoutComponent] LayoutComponent 
 -- @param self
 -- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)

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

@@ -5,41 +5,44 @@
 -- @parent_module ccui
 
 --------------------------------
--- 
+-- Create a copy of original LayoutParameter.<br>
+-- return A LayoutParameter pointer.
 -- @function [parent=#LayoutParameter] clone 
 -- @param self
 -- @return LayoutParameter#LayoutParameter ret (return value: ccui.LayoutParameter)
         
 --------------------------------
 -- Gets LayoutParameterType of LayoutParameter.<br>
--- see LayoutParameterType<br>
+-- see LayoutParameterType.<br>
 -- return LayoutParameterType
 -- @function [parent=#LayoutParameter] getLayoutType 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- Create a cloned instance of LayoutParameter.<br>
+-- return A LayoutParameter pointer.
 -- @function [parent=#LayoutParameter] createCloneInstance 
 -- @param self
 -- @return LayoutParameter#LayoutParameter ret (return value: ccui.LayoutParameter)
         
 --------------------------------
--- 
+-- Copy all the member field from argument LayoutParameter to self.<br>
+-- parameter model A LayoutParameter instance.
 -- @function [parent=#LayoutParameter] copyProperties 
 -- @param self
 -- @param #ccui.LayoutParameter model
 -- @return LayoutParameter#LayoutParameter self (return value: ccui.LayoutParameter)
         
 --------------------------------
--- Allocates and initializes.<br>
+-- Create a empty LayoutParameter.<br>
--- return A initialized LayoutParameter which is marked as "autorelease".
+-- return A autorelease LayoutParameter instance.
 -- @function [parent=#LayoutParameter] create 
 -- @param self
 -- @return LayoutParameter#LayoutParameter ret (return value: ccui.LayoutParameter)
         
 --------------------------------
--- Default constructor
+-- Default constructor.
 -- @function [parent=#LayoutParameter] LayoutParameter 
 -- @param self
 -- @return LayoutParameter#LayoutParameter self (return value: ccui.LayoutParameter)

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

@@ -7,7 +7,7 @@
 --------------------------------
 -- Sets LinearGravity parameter for LayoutParameter.<br>
 -- see LinearGravity<br>
--- param LinearGravity
+-- param LinearGravity Gravity in LinearGravity.
 -- @function [parent=#LinearLayoutParameter] setGravity 
 -- @param self
 -- @param #int gravity
@@ -22,7 +22,7 @@
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- Allocates and initializes.<br>
+-- Create a empty LinearLayoutParameter instance.<br>
 -- return A initialized LayoutParameter which is marked as "autorelease".
 -- @function [parent=#LinearLayoutParameter] create 
 -- @param self
@@ -42,7 +42,7 @@
 -- @return LinearLayoutParameter#LinearLayoutParameter self (return value: ccui.LinearLayoutParameter)
         
 --------------------------------
--- Default constructor
+-- Default constructor.
 -- @function [parent=#LinearLayoutParameter] LinearLayoutParameter 
 -- @param self
 -- @return LinearLayoutParameter#LinearLayoutParameter self (return value: ccui.LinearLayoutParameter)

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

@@ -5,70 +5,75 @@
 -- @parent_module ccui
 
 --------------------------------
--- Returns the index of item.<br>
+-- Return the index of specified widget.<br>
--- param item  the item which need to be checked.<br>
+-- param item  A widget pointer.<br>
--- return the index of item.
+-- return The index of a given widget in ListView.
 -- @function [parent=#ListView] getIndex 
 -- @param self
 -- @param #ccui.Widget item
 -- @return long#long ret (return value: long)
         
 --------------------------------
--- 
+-- brief Remove all items in current ListView.
 -- @function [parent=#ListView] removeAllItems 
 -- @param self
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- Changes the gravity of listview.<br>
+-- Set the gravity of ListView.<br>
--- see ListViewGravity
+-- see `ListViewGravity`
 -- @function [parent=#ListView] setGravity 
 -- @param self
 -- @param #int gravity
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- Push back custom item into listview.
+-- Insert a  custom item into the end of ListView.<br>
+-- param item A item in `Widget*`.
 -- @function [parent=#ListView] pushBackCustomItem 
 -- @param self
 -- @param #ccui.Widget item
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- Returns the item container.
+-- Return all items in a ListView.<br>
+-- returns A vector of widget pointers.
 -- @function [parent=#ListView] getItems 
 -- @param self
 -- @return array_table#array_table ret (return value: array_table)
         
 --------------------------------
--- Removes a item whose index is same as the parameter.<br>
+-- Remove a item at given index.<br>
--- param index of item.
+-- param index A given index in ssize_t.
 -- @function [parent=#ListView] removeItem 
 -- @param self
 -- @param #long index
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- 
+-- brief Query current selected widget's idnex.<br>
+-- return A index of a selected item.
 -- @function [parent=#ListView] getCurSelectedIndex 
 -- @param self
 -- @return long#long ret (return value: long)
         
 --------------------------------
--- Insert a default item(create by a cloned model) into listview.
+-- Insert a default item(create by cloning model) into listview at a give index.<br>
+-- param index  A index in ssize_t.
 -- @function [parent=#ListView] insertDefaultItem 
 -- @param self
 -- @param #long index
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- 
+-- brief Refresh view and layout of ListView manually.<br>
+-- This method will mark ListView content as dirty and the content view will be refershed in the next frame.
 -- @function [parent=#ListView] requestRefreshView 
 -- @param self
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- Changes the margin between each item.<br>
+-- Set the margin between each item in ListView.<br>
 -- param margin
 -- @function [parent=#ListView] setItemsMargin 
 -- @param self
@@ -76,43 +81,45 @@
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- 
+-- brief Refresh content view of ListView.
 -- @function [parent=#ListView] refreshView 
 -- @param self
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- Removes the last item of listview.
+-- Removes the last item of ListView.
 -- @function [parent=#ListView] removeLastItem 
 -- @param self
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- 
+-- brief Query margin between each item in ListView.<br>
+-- return A margin in float.
 -- @function [parent=#ListView] getItemsMargin 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- Add a event click callback to ListView, then one item of Listview is clicked, the callback will be called.<br>
+-- param callback A callback function with type of `ccListViewCallback`.
 -- @function [parent=#ListView] addEventListener 
 -- @param self
 -- @param #function callback
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- Returns a item whose index is same as the parameter.<br>
+-- Return a item at a given index.<br>
--- param index of item.<br>
+-- param index A given index in ssize_t.<br>
--- return the item widget.
+-- return A widget instance.
 -- @function [parent=#ListView] getItem 
 -- @param self
 -- @param #long index
 -- @return Widget#Widget ret (return value: ccui.Widget)
         
 --------------------------------
--- Sets a item model for listview<br>
+-- Set a item model for listview.<br>
--- A model will be cloned for adding default item.<br>
+-- When calling @see `pushBackDefaultItem`, the model will be used as a blueprint and new model copy will be inserted into ListView.<br>
--- param model  item model for listview
+-- param model  Model in `Widget*`.
 -- @function [parent=#ListView] setItemModel 
 -- @param self
 -- @param #ccui.Widget model
@@ -125,13 +132,15 @@
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- Push back a default item(create by a cloned model) into listview.
+-- Insert a  a default item(create by a cloned model) at the end of the listview.
 -- @function [parent=#ListView] pushBackDefaultItem 
 -- @param self
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- Insert custom item into listview.
+-- brief Insert a custom widget into ListView at a given index.<br>
+-- param item A widget pointer to be inserted.<br>
+-- param index A given index in ssize_t.
 -- @function [parent=#ListView] insertCustomItem 
 -- @param self
 -- @param #ccui.Widget item
@@ -139,7 +148,8 @@
 -- @return ListView#ListView self (return value: ccui.ListView)
         
 --------------------------------
--- Allocates and initializes.
+-- Create an empty ListView.<br>
+-- return A ListView instance.
 -- @function [parent=#ListView] create 
 -- @param self
 -- @return ListView#ListView ret (return value: ccui.ListView)

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

@@ -5,17 +5,17 @@
 -- @parent_module ccui
 
 --------------------------------
--- Changes the progress direction of loadingbar.<br>
+-- Changes the progress value of LoadingBar.<br>
--- param percent    percent value from 1 to 100.
+-- param percent   Percent value from 1 to 100.
 -- @function [parent=#LoadingBar] setPercent 
 -- @param self
 -- @param #float percent
 -- @return LoadingBar#LoadingBar self (return value: ccui.LoadingBar)
         
 --------------------------------
--- Load texture for loadingbar.<br>
+-- Load texture for LoadingBar.<br>
--- param texture   file name of texture.<br>
+-- param texture   File name of texture.<br>
--- param texType    @see TextureResType
+-- param texType   Texture resource type,@see TextureResType.
 -- @function [parent=#LoadingBar] loadTexture 
 -- @param self
 -- @param #string texture
@@ -23,8 +23,8 @@
 -- @return LoadingBar#LoadingBar self (return value: ccui.LoadingBar)
         
 --------------------------------
--- Changes the progress direction of loadingbar.<br>
+-- Change the progress direction of LoadingBar.<br>
--- see Direction  LEFT means progress left to right, RIGHT otherwise.<br>
+-- see Direction  `LEFT` means progress left to right, `RIGHT` otherwise.<br>
 -- param direction Direction
 -- @function [parent=#LoadingBar] setDirection 
 -- @param self
@@ -32,44 +32,47 @@
 -- @return LoadingBar#LoadingBar self (return value: ccui.LoadingBar)
         
 --------------------------------
--- Sets if loadingbar is using scale9 renderer.<br>
+-- Enable scale9 renderer.<br>
--- param enabled true that using scale9 renderer, false otherwise.
+-- param enabled Set to true will use scale9 renderer, false otherwise.
 -- @function [parent=#LoadingBar] setScale9Enabled 
 -- @param self
 -- @param #bool enabled
 -- @return LoadingBar#LoadingBar self (return value: ccui.LoadingBar)
         
 --------------------------------
--- Sets capinsets for loadingbar, if loadingbar is using scale9 renderer.<br>
+-- Set capInsets for LoadingBar.<br>
--- param capInsets    capinsets for loadingbar
+-- This setting only take effect when enable scale9 renderer.<br>
+-- param capInsets CapInset in `Rect`.
 -- @function [parent=#LoadingBar] setCapInsets 
 -- @param self
 -- @param #rect_table capInsets
 -- @return LoadingBar#LoadingBar self (return value: ccui.LoadingBar)
         
 --------------------------------
--- Gets the progress direction of loadingbar.<br>
+-- Get the progress direction of LoadingBar.<br>
--- see Direction  LEFT means progress left to right, RIGHT otherwise.<br>
+-- see Direction  `LEFT` means progress left to right, `RIGHT` otherwise.<br>
--- return Direction
+-- return LoadingBar progress direction.
 -- @function [parent=#LoadingBar] getDirection 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- brief Query LoadingBar's capInsets.<br>
+-- return CapInsets of LoadingBar.
 -- @function [parent=#LoadingBar] getCapInsets 
 -- @param self
 -- @return rect_table#rect_table ret (return value: rect_table)
         
 --------------------------------
--- 
+-- brief Query whether LoadingBar is using scale9 renderer or not.<br>
+-- return Whether LoadingBar uses scale9 renderer or not.
 -- @function [parent=#LoadingBar] isScale9Enabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- Gets the progress direction of loadingbar.<br>
+-- Get the progress value of LoadingBar.<br>
--- return percent value from 1 to 100.
+-- return Progress value from 1 to 100.
 -- @function [parent=#LoadingBar] getPercent 
 -- @param self
 -- @return float#float ret (return value: float)
@@ -98,7 +101,7 @@
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
--- Returns the "class name" of widget.
+-- 
 -- @function [parent=#LoadingBar] getDescription 
 -- @param self
 -- @return string#string ret (return value: string)
@@ -117,7 +120,7 @@
 -- @return LoadingBar#LoadingBar self (return value: ccui.LoadingBar)
         
 --------------------------------
--- Default constructor
+-- Default constructor.
 -- @function [parent=#LoadingBar] LoadingBar 
 -- @param self
 -- @return LoadingBar#LoadingBar self (return value: ccui.LoadingBar)

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

@@ -5,26 +5,30 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+-- Set whether the menu is visible.<br>
+-- The default value is true, a menu is default to visible.<br>
+-- param value true if menu is enable, false if menu is disable.
 -- @function [parent=#Menu] setEnabled 
 -- @param self
 -- @param #bool value
 -- @return Menu#Menu self (return value: cc.Menu)
         
 --------------------------------
---  align items vertically 
+--  Align items vertically. 
 -- @function [parent=#Menu] alignItemsVertically 
 -- @param self
 -- @return Menu#Menu self (return value: cc.Menu)
         
 --------------------------------
--- 
+-- Determines if the menu is enable.<br>
+-- see `setEnabled(bool)`.<br>
+-- return whether the menu is enabled or not.
 -- @function [parent=#Menu] isEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  align items horizontally with padding<br>
+--  Align items horizontally with padding.<br>
 -- since v0.7.2
 -- @function [parent=#Menu] alignItemsHorizontallyWithPadding 
 -- @param self
@@ -32,7 +36,7 @@
 -- @return Menu#Menu self (return value: cc.Menu)
         
 --------------------------------
---  align items vertically with padding<br>
+--  Align items vertically with padding.<br>
 -- since v0.7.2
 -- @function [parent=#Menu] alignItemsVerticallyWithPadding 
 -- @param self
@@ -40,7 +44,7 @@
 -- @return Menu#Menu self (return value: cc.Menu)
         
 --------------------------------
---  align items horizontally 
+--  Align items horizontally. 
 -- @function [parent=#Menu] alignItemsHorizontally 
 -- @param self
 -- @return Menu#Menu self (return value: cc.Menu)

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

@@ -5,44 +5,44 @@
 -- @parent_module cc
 
 --------------------------------
---  enables or disables the item 
+--  Enables or disables the item. 
 -- @function [parent=#MenuItem] setEnabled 
 -- @param self
 -- @param #bool value
 -- @return MenuItem#MenuItem self (return value: cc.MenuItem)
         
 --------------------------------
---  Activate the item 
+--  Activate the item. 
 -- @function [parent=#MenuItem] activate 
 -- @param self
 -- @return MenuItem#MenuItem self (return value: cc.MenuItem)
         
 --------------------------------
---  returns whether or not the item is enabled 
+--  Returns whether or not the item is enabled. 
 -- @function [parent=#MenuItem] isEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  The item was selected (not activated), similar to "mouse-over" 
+--  The item was selected (not activated), similar to "mouse-over". 
 -- @function [parent=#MenuItem] selected 
 -- @param self
 -- @return MenuItem#MenuItem self (return value: cc.MenuItem)
         
 --------------------------------
---  returns whether or not the item is selected 
+--  Returns whether or not the item is selected. 
 -- @function [parent=#MenuItem] isSelected 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
---  The item was unselected 
+--  The item was unselected. 
 -- @function [parent=#MenuItem] unselected 
 -- @param self
 -- @return MenuItem#MenuItem self (return value: cc.MenuItem)
         
 --------------------------------
---  Returns the outside box 
+--  Returns the outside box. 
 -- @function [parent=#MenuItem] rect 
 -- @param self
 -- @return rect_table#rect_table ret (return value: rect_table)

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

@@ -5,23 +5,23 @@
 -- @parent_module cc
 
 --------------------------------
---  get font size <br>
+--  get font size .<br>
 -- js getFontSize
 -- @function [parent=#MenuItemFont] getFontSizeObj 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  returns the name of the Font <br>
+--  Returns the name of the Font.<br>
 -- js getFontNameObj
 -- @function [parent=#MenuItemFont] getFontNameObj 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
---  set font size<br>
+--  Set font size.<br>
--- c++ can not overload static and non-static member functions with the same parameter types<br>
+-- c++ can not overload static and non-static member functions with the same parameter types.<br>
--- so change the name to setFontSizeObj<br>
+-- so change the name to setFontSizeObj.<br>
 -- js setFontSize
 -- @function [parent=#MenuItemFont] setFontSizeObj 
 -- @param self
@@ -29,9 +29,9 @@
 -- @return MenuItemFont#MenuItemFont self (return value: cc.MenuItemFont)
         
 --------------------------------
---  set the font name <br>
+-- Set the font name .<br>
--- c++ can not overload static and non-static member functions with the same parameter types<br>
+-- c++ can not overload static and non-static member functions with the same parameter types.<br>
--- so change the name to setFontNameObj<br>
+-- so change the name to setFontNameObj.<br>
 -- js setFontName
 -- @function [parent=#MenuItemFont] setFontNameObj 
 -- @param self
@@ -39,26 +39,26 @@
 -- @return MenuItemFont#MenuItemFont self (return value: cc.MenuItemFont)
         
 --------------------------------
---  set the default font name 
+--  Set the default font name. 
 -- @function [parent=#MenuItemFont] setFontName 
 -- @param self
 -- @param #string name
 -- @return MenuItemFont#MenuItemFont self (return value: cc.MenuItemFont)
         
 --------------------------------
---  get default font size 
+--  Get default font size. 
 -- @function [parent=#MenuItemFont] getFontSize 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
---  get the default font name 
+--  Get the default font name. 
 -- @function [parent=#MenuItemFont] getFontName 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
---  set default font size 
+--  Set default font size. 
 -- @function [parent=#MenuItemFont] setFontSize 
 -- @param self
 -- @param #int size

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

@@ -5,21 +5,21 @@
 -- @parent_module cc
 
 --------------------------------
---  sets the sprite frame for the disabled image 
+--  Sets the sprite frame for the disabled image. 
 -- @function [parent=#MenuItemImage] setDisabledSpriteFrame 
 -- @param self
 -- @param #cc.SpriteFrame frame
 -- @return MenuItemImage#MenuItemImage self (return value: cc.MenuItemImage)
         
 --------------------------------
---  sets the sprite frame for the selected image 
+--  Sets the sprite frame for the selected image. 
 -- @function [parent=#MenuItemImage] setSelectedSpriteFrame 
 -- @param self
 -- @param #cc.SpriteFrame frame
 -- @return MenuItemImage#MenuItemImage self (return value: cc.MenuItemImage)
         
 --------------------------------
---  sets the sprite frame for the normal image 
+--  Sets the sprite frame for the normal image. 
 -- @function [parent=#MenuItemImage] setNormalSpriteFrame 
 -- @param self
 -- @param #cc.SpriteFrame frame

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

@@ -5,13 +5,13 @@
 -- @parent_module cc
 
 --------------------------------
---  Gets the color that will be used to disable the item 
+--  Gets the color that will be used to disable the item. 
 -- @function [parent=#MenuItemLabel] getDisabledColor 
 -- @param self
 -- @return color3b_table#color3b_table ret (return value: color3b_table)
         
 --------------------------------
---  sets a new string to the inner label 
+--  Sets a new string to the inner label. 
 -- @function [parent=#MenuItemLabel] setString 
 -- @param self
 -- @param #string label
@@ -25,7 +25,7 @@
 -- @return MenuItemLabel#MenuItemLabel self (return value: cc.MenuItemLabel)
         
 --------------------------------
---  Sets the color that will be used to disable the item 
+--  Sets the color that will be used to disable the item. 
 -- @function [parent=#MenuItemLabel] setDisabledColor 
 -- @param self
 -- @param #color3b_table color

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

@@ -5,59 +5,60 @@
 -- @parent_module cc
 
 --------------------------------
--- 
+--  Enables or disables the item. 
 -- @function [parent=#MenuItemSprite] setEnabled 
 -- @param self
 -- @param #bool bEnabled
 -- @return MenuItemSprite#MenuItemSprite self (return value: cc.MenuItemSprite)
         
 --------------------------------
+-- The item was selected (not activated), similar to "mouse-over".<br>
 -- since v0.99.5
 -- @function [parent=#MenuItemSprite] selected 
 -- @param self
 -- @return MenuItemSprite#MenuItemSprite self (return value: cc.MenuItemSprite)
         
 --------------------------------
---  Sets the image used when the item is not selected 
+--  Sets the image used when the item is not selected. 
 -- @function [parent=#MenuItemSprite] setNormalImage 
 -- @param self
 -- @param #cc.Node image
 -- @return MenuItemSprite#MenuItemSprite self (return value: cc.MenuItemSprite)
         
 --------------------------------
---  Sets the image used when the item is disabled 
+--  Sets the image used when the item is disabled. 
 -- @function [parent=#MenuItemSprite] setDisabledImage 
 -- @param self
 -- @param #cc.Node image
 -- @return MenuItemSprite#MenuItemSprite self (return value: cc.MenuItemSprite)
         
 --------------------------------
---  Sets the image used when the item is selected 
+--  Sets the image used when the item is selected. 
 -- @function [parent=#MenuItemSprite] setSelectedImage 
 -- @param self
 -- @param #cc.Node image
 -- @return MenuItemSprite#MenuItemSprite self (return value: cc.MenuItemSprite)
         
 --------------------------------
---  Gets the image used when the item is disabled 
+--  Gets the image used when the item is disabled. 
 -- @function [parent=#MenuItemSprite] getDisabledImage 
 -- @param self
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
---  Gets the image used when the item is selected 
+--  Gets the image used when the item is selected. 
 -- @function [parent=#MenuItemSprite] getSelectedImage 
 -- @param self
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
---  Gets the image used when the item is not selected 
+--  Gets the image used when the item is not selected. 
 -- @function [parent=#MenuItemSprite] getNormalImage 
 -- @param self
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
--- 
+--  The item was unselected. 
 -- @function [parent=#MenuItemSprite] unselected 
 -- @param self
 -- @return MenuItemSprite#MenuItemSprite self (return value: cc.MenuItemSprite)

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

@@ -12,26 +12,26 @@
 -- @return MenuItemToggle#MenuItemToggle self (return value: cc.MenuItemToggle)
         
 --------------------------------
---  Gets the index of the selected item 
+--  Gets the index of the selected item. 
 -- @function [parent=#MenuItemToggle] getSelectedIndex 
 -- @param self
 -- @return unsigned int#unsigned int ret (return value: unsigned int)
         
 --------------------------------
---  add more menu item 
+--  Add more menu item. 
 -- @function [parent=#MenuItemToggle] addSubItem 
 -- @param self
 -- @param #cc.MenuItem item
 -- @return MenuItemToggle#MenuItemToggle self (return value: cc.MenuItemToggle)
         
 --------------------------------
---  return the selected item 
+--  Return the selected item. 
 -- @function [parent=#MenuItemToggle] getSelectedItem 
 -- @param self
 -- @return MenuItem#MenuItem ret (return value: cc.MenuItem)
         
 --------------------------------
---  Sets the index of the selected item 
+--  Sets the index of the selected item. 
 -- @function [parent=#MenuItemToggle] setSelectedIndex 
 -- @param self
 -- @param #unsigned int index

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

@@ -5,23 +5,24 @@
 -- @parent_module ccui
 
 --------------------------------
--- brief Return user defined scroll page threshold
+-- brief Query the custom scroll threshold of the PageView.<br>
+-- return Custom scroll threshold in float.
 -- @function [parent=#PageView] getCustomScrollThreshold 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- Gets current page index.<br>
+-- Gets current displayed page index.<br>
 -- return current page index.
 -- @function [parent=#PageView] getCurPageIndex 
 -- @param self
 -- @return long#long ret (return value: long)
         
 --------------------------------
--- Add a widget to a page of pageview.<br>
+-- Add a widget as a page of PageView in a given index.<br>
--- param widget    widget to be added to pageview.<br>
+-- param widget    Widget to be added to pageview.<br>
--- param pageIdx   index of page.<br>
+-- param pageIdx   A given index.<br>
--- param forceCreate   if force create and there is no page exsit, pageview would create a default page for adding widget.
+-- param forceCreate   If `forceCreate` is true and `widget` isn't exists, pageview would create a default page and add it.
 -- @function [parent=#PageView] addWidgetToPage 
 -- @param self
 -- @param #ccui.Widget widget
@@ -30,51 +31,58 @@
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- brief Query whether we are using user defined scroll page threshold or not
+-- brief Query whether use user defined scroll page threshold or not.<br>
+-- return True if using custom scroll threshold, false otherwise.
 -- @function [parent=#PageView] isUsingCustomScrollThreshold 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Get a page at a given index<br>
+-- param index A given index.<br>
+-- return A layout pointer in PageView container.
 -- @function [parent=#PageView] getPage 
 -- @param self
 -- @param #long index
 -- @return Layout#Layout ret (return value: ccui.Layout)
         
 --------------------------------
--- Remove a page of pageview.<br>
+-- Remove a page of PageView.<br>
--- param page    page which will be removed.
+-- param page  Page to be removed.
 -- @function [parent=#PageView] removePage 
 -- @param self
 -- @param #ccui.Layout page
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- 
+-- brief Add a page turn callback to PageView, then when one page is turning, the callback will be called.<br>
+-- param callback A page turning callback.
 -- @function [parent=#PageView] addEventListener 
 -- @param self
 -- @param #function callback
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- brief Set using user defined scroll page threshold or not<br>
+-- brief Set using user defined scroll page threshold or not.<br>
--- If you set it to false, then the default scroll threshold is pageView.width / 2
+-- If you set it to false, then the default scroll threshold is pageView.width / 2<br>
+-- param flag True if using custom scroll threshold, false otherwise.
 -- @function [parent=#PageView] setUsingCustomScrollThreshold 
 -- @param self
 -- @param #bool flag
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- brief If you don't specify the value, the pageView will scroll when half pageview width reached
+-- brief If you don't specify the value, the pageView will turn page when scrolling at the half width of a page.<br>
+-- param threshold  A threshold in float.
 -- @function [parent=#PageView] setCustomScrollThreshold 
 -- @param self
 -- @param #float threshold
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- Insert a page to pageview.<br>
+-- Insert a page into PageView at a given index.<br>
--- param page    page to be added to pageview.
+-- param page  Page to be inserted.<br>
+-- param idx   A given index.
 -- @function [parent=#PageView] insertPage 
 -- @param self
 -- @param #ccui.Layout page
@@ -82,43 +90,45 @@
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- scroll pageview to index.<br>
+-- Scroll to a page with a given index.<br>
--- param idx    index of page.
+-- param idx   A given index in the PageView.
 -- @function [parent=#PageView] scrollToPage 
 -- @param self
 -- @param #long idx
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- Remove a page at index of pageview.<br>
+-- Remove a page at a given index of PageView.<br>
--- param index    index of page.
+-- param index  A given index.
 -- @function [parent=#PageView] removePageAtIndex 
 -- @param self
 -- @param #long index
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- 
+-- brief Get all the pages in the PageView.<br>
+-- return A vector of Layout pionters.
 -- @function [parent=#PageView] getPages 
 -- @param self
 -- @return array_table#array_table ret (return value: array_table)
         
 --------------------------------
--- 
+-- brief Remove all pages of the PageView.
 -- @function [parent=#PageView] removeAllPages 
 -- @param self
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- Push back a page to pageview.<br>
+-- Insert a page into the end of PageView.<br>
--- param page    page to be added to pageview.
+-- param page Page to be inserted.
 -- @function [parent=#PageView] addPage 
 -- @param self
 -- @param #ccui.Layout page
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- Allocates and initializes.
+-- Create an empty PageView.<br>
+-- return A PageView instance.
 -- @function [parent=#PageView] create 
 -- @param self
 -- @return PageView#PageView ret (return value: ccui.PageView)
@@ -130,15 +140,13 @@
 -- @return Ref#Ref ret (return value: cc.Ref)
         
 --------------------------------
--- Gets LayoutType.<br>
+-- 
--- see LayoutType<br>
--- return LayoutType
 -- @function [parent=#PageView] getLayoutType 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- Returns the "class name" of widget.
+-- 
 -- @function [parent=#PageView] getDescription 
 -- @param self
 -- @return string#string ret (return value: string)
@@ -151,9 +159,7 @@
 -- @return PageView#PageView self (return value: ccui.PageView)
         
 --------------------------------
--- Sets LayoutType.<br>
+-- 
--- see LayoutType<br>
--- param type LayoutType
 -- @function [parent=#PageView] setLayoutType 
 -- @param self
 -- @param #int type

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

@@ -22,8 +22,8 @@
 -- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
         
 --------------------------------
--- Removes a child from the container by tag value. It will also cleanup all running actions depending on the cleanup parameter<br>
+-- Removes a child from the container by tag value. It will also cleanup all running actions depending on the cleanup parameter.<br>
--- param tag       An interger number that identifies a child node<br>
+-- param tag       An interger number that identifies a child node.<br>
 -- param cleanup   true if all running actions and callbacks on the child node will be cleanup, false otherwise.
 -- @function [parent=#ProtectedNode] removeProtectedChildByTag 
 -- @param self
@@ -66,9 +66,9 @@
 -- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
         
 --------------------------------
--- Gets a child from the container with its tag<br>
+-- Gets a child from the container with its tag.<br>
 -- param tag   An identifier to find the child node.<br>
--- return a Node object whose tag equals to the input parameter
+-- return a Node object whose tag equals to the input parameter.
 -- @function [parent=#ProtectedNode] getProtectedChildByTag 
 -- @param self
 -- @param #int tag
@@ -86,13 +86,14 @@
         
 --------------------------------
 -- Removes all children from the container with a cleanup.<br>
--- see `removeAllChildrenWithCleanup(bool)`
+-- see `removeAllChildrenWithCleanup(bool)`.
 -- @function [parent=#ProtectedNode] removeAllProtectedChildren 
 -- @param self
 -- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
         
 --------------------------------
--- 
+-- Creates a ProtectedNode with no argument.<br>
+-- return A instance of ProtectedNode.
 -- @function [parent=#ProtectedNode] create 
 -- @param self
 -- @return ProtectedNode#ProtectedNode ret (return value: cc.ProtectedNode)

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

@@ -13,7 +13,7 @@
 -- @return RelativeBox#RelativeBox ret (return value: ccui.RelativeBox)
 
 --------------------------------
--- Default constructor
+-- Default constructor.
 -- @function [parent=#RelativeBox] RelativeBox 
 -- @param self
 -- @return RelativeBox#RelativeBox self (return value: ccui.RelativeBox)

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

@@ -7,52 +7,52 @@
 --------------------------------
 -- Sets RelativeAlign parameter for LayoutParameter.<br>
 -- see RelativeAlign<br>
--- param RelativeAlign
+-- param RelativeAlign Relative align in @see `RelativeAlign`.
 -- @function [parent=#RelativeLayoutParameter] setAlign 
 -- @param self
 -- @param #int align
 -- @return RelativeLayoutParameter#RelativeLayoutParameter self (return value: ccui.RelativeLayoutParameter)
         
 --------------------------------
--- Sets a key for LayoutParameter. Witch widget named this is relative to.<br>
+-- Set widget name your widget want to relative to.<br>
--- param name
+-- param name Relative widget name.
 -- @function [parent=#RelativeLayoutParameter] setRelativeToWidgetName 
 -- @param self
 -- @param #string name
 -- @return RelativeLayoutParameter#RelativeLayoutParameter self (return value: ccui.RelativeLayoutParameter)
         
 --------------------------------
--- Gets a name in Relative Layout of LayoutParameter.<br>
+-- Get a name of LayoutParameter in Relative Layout.<br>
--- return name
+-- return name Relative name in string.
 -- @function [parent=#RelativeLayoutParameter] getRelativeName 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- Gets the key of LayoutParameter. Witch widget named this is relative to.<br>
+-- Get the relative widget name.<br>
--- return name
+-- return name A relative widget name in string.
 -- @function [parent=#RelativeLayoutParameter] getRelativeToWidgetName 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- Sets a name in Relative Layout for LayoutParameter.<br>
+-- Set a name for LayoutParameter in Relative Layout.<br>
--- param name
+-- param name A string name.
 -- @function [parent=#RelativeLayoutParameter] setRelativeName 
 -- @param self
 -- @param #string name
 -- @return RelativeLayoutParameter#RelativeLayoutParameter self (return value: ccui.RelativeLayoutParameter)
         
 --------------------------------
--- Gets RelativeAlign parameter for LayoutParameter.<br>
+-- Get RelativeAlign parameter for LayoutParameter.<br>
 -- see RelativeAlign<br>
--- return RelativeAlign
+-- return RelativeAlign A RelativeAlign variable.
 -- @function [parent=#RelativeLayoutParameter] getAlign 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- Allocates and initializes.<br>
+-- Create a RelativeLayoutParameter instance.<br>
 -- return A initialized LayoutParameter which is marked as "autorelease".
 -- @function [parent=#RelativeLayoutParameter] create 
 -- @param self

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

@@ -5,7 +5,11 @@
 -- @parent_module ccui
 
 --------------------------------
--- 
+-- brief Initialize a rich element with different arguments.<br>
+-- param tag A integer tag value.<br>
+-- param color A color in @see `Color3B`.<br>
+-- param opacity A opacity value in `GLubyte`.<br>
+-- return True if initialize success, false otherwise.
 -- @function [parent=#RichElement] init 
 -- @param self
 -- @param #int tag
@@ -14,7 +18,7 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Default constructor.
 -- @function [parent=#RichElement] RichElement 
 -- @param self
 -- @return RichElement#RichElement self (return value: ccui.RichElement)

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

@@ -5,7 +5,12 @@
 -- @parent_module ccui
 
 --------------------------------
--- 
+-- brief Initialize a RichElementCustomNode with various arguments.<br>
+-- param tag A integer tag value.<br>
+-- param color A color in Color3B.<br>
+-- param opacity A opacity in GLubyte.<br>
+-- param customNode A custom node pointer.<br>
+-- return True if initialize success, false otherwise.
 -- @function [parent=#RichElementCustomNode] init 
 -- @param self
 -- @param #int tag
@@ -15,7 +20,12 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Create a RichElementCustomNode with various arguments.<br>
+-- param tag A integer tag value.<br>
+-- param color A color in Color3B.<br>
+-- param opacity A opacity in GLubyte.<br>
+-- param customNode A custom node pointer.<br>
+-- return A RichElementCustomNode instance.
 -- @function [parent=#RichElementCustomNode] create 
 -- @param self
 -- @param #int tag
@@ -25,7 +35,7 @@
 -- @return RichElementCustomNode#RichElementCustomNode ret (return value: ccui.RichElementCustomNode)
         
 --------------------------------
--- 
+-- brief Default constructor.
 -- @function [parent=#RichElementCustomNode] RichElementCustomNode 
 -- @param self
 -- @return RichElementCustomNode#RichElementCustomNode self (return value: ccui.RichElementCustomNode)

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

@@ -5,7 +5,12 @@
 -- @parent_module ccui
 
 --------------------------------
--- 
+-- brief Initialize a RichElementImage with various arguments.<br>
+-- param tag A integer tag value.<br>
+-- param color A color in Color3B.<br>
+-- param opacity A opacity in GLubyte.<br>
+-- param filePath A image file name.<br>
+-- return True if initialize success, false otherwise.
 -- @function [parent=#RichElementImage] init 
 -- @param self
 -- @param #int tag
@@ -15,7 +20,12 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Create a RichElementImage with various arguments.<br>
+-- param tag A integer tag value.<br>
+-- param color A color in Color3B.<br>
+-- param opacity A opacity in GLubyte.<br>
+-- param filePath A image file name.<br>
+-- return A RichElementImage instance.
 -- @function [parent=#RichElementImage] create 
 -- @param self
 -- @param #int tag
@@ -25,7 +35,7 @@
 -- @return RichElementImage#RichElementImage ret (return value: ccui.RichElementImage)
         
 --------------------------------
--- 
+-- brief Default constructor.
 -- @function [parent=#RichElementImage] RichElementImage 
 -- @param self
 -- @return RichElementImage#RichElementImage self (return value: ccui.RichElementImage)

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

@@ -5,7 +5,14 @@
 -- @parent_module ccui
 
 --------------------------------
--- 
+-- brief Initialize a RichElementText with various arguments.<br>
+-- param tag A integer tag value.<br>
+-- param color A color in Color3B.<br>
+-- param opacity A opacity in GLubyte.<br>
+-- param text Content string.<br>
+-- param fontName Content font name.<br>
+-- param fontSize Content font size.<br>
+-- return True if initialize scucess, false otherwise.
 -- @function [parent=#RichElementText] init 
 -- @param self
 -- @param #int tag
@@ -17,7 +24,14 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Create a RichElementText with various arguments.<br>
+-- param tag A integer tag value.<br>
+-- param color A color in Color3B.<br>
+-- param opacity A opacity in GLubyte.<br>
+-- param text Content string.<br>
+-- param fontName Content font name.<br>
+-- param fontSize Content font size.<br>
+-- return RichElementText instance.
 -- @function [parent=#RichElementText] create 
 -- @param self
 -- @param #int tag
@@ -29,7 +43,7 @@
 -- @return RichElementText#RichElementText ret (return value: ccui.RichElementText)
         
 --------------------------------
--- 
+-- brief Default constructor.
 -- @function [parent=#RichElementText] RichElementText 
 -- @param self
 -- @return RichElementText#RichElementText self (return value: ccui.RichElementText)

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

@@ -5,7 +5,9 @@
 -- @parent_module ccui
 
 --------------------------------
--- 
+-- brief Insert a RichElement at a given index.<br>
+-- param element A RichElement type.<br>
+-- param index A given index.
 -- @function [parent=#RichText] insertElement 
 -- @param self
 -- @param #ccui.RichElement element
@@ -13,21 +15,24 @@
 -- @return RichText#RichText self (return value: ccui.RichText)
         
 --------------------------------
--- 
+-- brief Add a RichElement at the end of RichText.<br>
+-- param element A RichElement instance.
 -- @function [parent=#RichText] pushBackElement 
 -- @param self
 -- @param #ccui.RichElement element
 -- @return RichText#RichText self (return value: ccui.RichText)
         
 --------------------------------
--- 
+-- brief Set vertical space between each RichElement.<br>
+-- param space Point in float.
 -- @function [parent=#RichText] setVerticalSpace 
 -- @param self
 -- @param #float space
 -- @return RichText#RichText self (return value: ccui.RichText)
         
 --------------------------------
--- 
+-- brief Rearrange all RichElement in the RichText.<br>
+-- It's usually called internally.
 -- @function [parent=#RichText] formatText 
 -- @param self
 -- @return RichText#RichText self (return value: ccui.RichText)
@@ -41,7 +46,8 @@
 -- @return RichText#RichText self (return value: ccui.RichText)
 
 --------------------------------
--- 
+-- brief Create a empty RichText.<br>
+-- return RichText instance.
 -- @function [parent=#RichText] create 
 -- @param self
 -- @return RichText#RichText ret (return value: ccui.RichText)
@@ -73,7 +79,7 @@
 -- @return RichText#RichText self (return value: ccui.RichText)
         
 --------------------------------
--- 
+-- brief Default constructor.
 -- @function [parent=#RichText] RichText 
 -- @param self
 -- @return RichText#RichText self (return value: ccui.RichText)

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

@@ -35,7 +35,9 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Toggle 9-slice feature.<br>
+-- If Scale9Sprite is 9-slice disabled, the Scale9Sprite will rendered as a normal sprite.<br>
+-- param enabled True to enable 9-slice, false otherwise.
 -- @function [parent=#Scale9Sprite] setScale9Enabled 
 -- @param self
 -- @param #bool enabled
@@ -43,7 +45,7 @@
         
 --------------------------------
 -- Sets whether the widget should be flipped vertically or not.<br>
--- param bFlippedY true if the widget should be flipped vertically, false otherwise.
+-- param flippedY true if the widget should be flipped vertically, false otherwise.
 -- @function [parent=#Scale9Sprite] setFlippedY 
 -- @param self
 -- @param #bool flippedY
@@ -51,7 +53,7 @@
         
 --------------------------------
 -- Sets whether the widget should be flipped horizontally or not.<br>
--- param bFlippedX true if the widget should be flipped horizontally, false otherwise.
+-- param flippedX true if the widget should be flipped horizontally, false otherwise.
 -- @function [parent=#Scale9Sprite] setFlippedX 
 -- @param self
 -- @param #bool flippedX
@@ -62,7 +64,8 @@
 -- You use this method to add cap insets to a sprite or to change the existing<br>
 -- cap insets of a sprite. In both cases, you get back a new image and the<br>
 -- original sprite remains untouched.<br>
--- param capInsets The values to use for the cap insets.
+-- param capInsets The values to use for the cap insets.<br>
+-- return A Scale9Sprite instance.
 -- @function [parent=#Scale9Sprite] resizableSpriteWithCapInsets 
 -- @param self
 -- @param #rect_table capInsets
@@ -75,6 +78,9 @@
 -- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
         
 --------------------------------
+-- Change the state of 9-slice sprite.<br>
+-- see `State`<br>
+-- param state A enum value in State.<br>
 -- since v3.4
 -- @function [parent=#Scale9Sprite] setState 
 -- @param self
@@ -82,7 +88,8 @@
 -- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
         
 --------------------------------
--- 
+-- brief Change the bottom sprite's cap inset.<br>
+-- param bottomInset The values to use for the cap inset.
 -- @function [parent=#Scale9Sprite] setInsetBottom 
 -- @param self
 -- @param #float bottomInset
@@ -98,13 +105,15 @@
 -- @return bool#bool ret (return value: bool)
 
 --------------------------------
--- 
+-- brief Get the original no 9-sliced sprite<br>
+-- return A sprite instance.
 -- @function [parent=#Scale9Sprite] getSprite 
 -- @param self
 -- @return Sprite#Sprite ret (return value: cc.Sprite)
         
 --------------------------------
--- 
+-- brief Change the top sprite's cap inset.<br>
+-- param topInset The values to use for the cap inset.
 -- @function [parent=#Scale9Sprite] setInsetTop 
 -- @param self
 -- @param #float topInset
@@ -126,14 +135,17 @@
 -- @return bool#bool ret (return value: bool)
 
 --------------------------------
--- 
+-- brief Change the prefered size of Scale9Sprite.<br>
+-- param size A delimitation zone.
 -- @function [parent=#Scale9Sprite] setPreferredSize 
 -- @param self
 -- @param #size_table size
 -- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
         
 --------------------------------
--- 
+-- brief Change inner sprite's sprite frame.<br>
+-- param spriteFrame A sprite frame pointer.<br>
+-- param capInsets The values to use for the cap insets.
 -- @function [parent=#Scale9Sprite] setSpriteFrame 
 -- @param self
 -- @param #cc.SpriteFrame spriteFrame
@@ -150,31 +162,36 @@
 -- @return BlendFunc#BlendFunc ret (return value: cc.BlendFunc)
         
 --------------------------------
--- 
+-- brief Query the bottom sprite's cap inset.<br>
+-- return The bottom sprite's cap inset.
 -- @function [parent=#Scale9Sprite] getInsetBottom 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Query the Scale9Sprite's prefered size.<br>
+-- return Scale9Sprite's cap inset.
 -- @function [parent=#Scale9Sprite] getCapInsets 
 -- @param self
 -- @return rect_table#rect_table ret (return value: rect_table)
         
 --------------------------------
--- 
+-- brief Query whether the Scale9Sprite is enable 9-slice or not.<br>
+-- return True if 9-slice is enabled, false otherwise.
 -- @function [parent=#Scale9Sprite] isScale9Enabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Query the right sprite's cap inset.<br>
+-- return The right sprite's cap inset.
 -- @function [parent=#Scale9Sprite] getInsetRight 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Query the sprite's original size.<br>
+-- return Sprite size.
 -- @function [parent=#Scale9Sprite] getOriginalSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
@@ -203,13 +220,15 @@
 -- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
         
 --------------------------------
--- 
+-- brief Query the top sprite's cap inset.<br>
+-- return The top sprite's cap inset.
 -- @function [parent=#Scale9Sprite] getInsetTop 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Change the left sprite's cap inset.<br>
+-- param leftInset The values to use for the cap inset.
 -- @function [parent=#Scale9Sprite] setInsetLeft 
 -- @param self
 -- @param #float leftInset
@@ -225,13 +244,15 @@
 -- @return bool#bool ret (return value: bool)
 
 --------------------------------
--- 
+-- brief Query the  Scale9Sprite's prefered size.<br>
+-- return Scale9Sprite's prefered size.
 -- @function [parent=#Scale9Sprite] getPreferredSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
--- 
+-- brief Change the cap inset size.<br>
+-- param rect A delimitation zone.
 -- @function [parent=#Scale9Sprite] setCapInsets 
 -- @param self
 -- @param #rect_table rect
@@ -249,13 +270,15 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Query the left sprite's cap inset.<br>
+-- return The left sprite's cap inset.
 -- @function [parent=#Scale9Sprite] getInsetLeft 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- 
+-- brief Change the right sprite's cap inset.<br>
+-- param rightInset The values to use for the cap inset.
 -- @function [parent=#Scale9Sprite] setInsetRight 
 -- @param self
 -- @param #float rightInset
@@ -376,6 +399,7 @@
 -- @return float#float ret (return value: float)
         
 --------------------------------
+-- Default constructor.<br>
 -- js ctor
 -- @function [parent=#Scale9Sprite] Scale9Sprite 
 -- @param self

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

@@ -5,7 +5,9 @@
 -- @parent_module ccui
 
 --------------------------------
--- Scroll inner container to top boundary of scrollview.
+-- Scroll inner container to top boundary of scrollview.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToTop 
 -- @param self
 -- @param #float time
@@ -13,7 +15,10 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Scroll inner container to horizontal percent position of scrollview.
+-- Scroll inner container to horizontal percent position of scrollview.<br>
+-- param percent A value between 0 and 100.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToPercentHorizontal 
 -- @param self
 -- @param #float percent
@@ -22,13 +27,17 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- 
+-- brief Query inertia scroll state.<br>
+-- return True if inertia is enabled, false otherwise.
 -- @function [parent=#ScrollView] isInertiaScrollEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- Scroll inner container to both direction percent position of scrollview.
+-- Scroll inner container to both direction percent position of scrollview.<br>
+-- param percent A value between 0 and 100.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToPercentBothDirection 
 -- @param self
 -- @param #vec2_table percent
@@ -37,15 +46,17 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Gets scroll direction of scrollview.<br>
+-- Query scroll direction of scrollview.<br>
--- see Direction      Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll<br>
+-- see `Direction`      Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll<br>
--- return Direction
+-- return Scrollview scroll direction.
 -- @function [parent=#ScrollView] getDirection 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- Scroll inner container to bottom and left boundary of scrollview.
+-- Scroll inner container to bottom and left boundary of scrollview.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToBottomLeft 
 -- @param self
 -- @param #float time
@@ -53,9 +64,9 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Gets inner container of scrollview.<br>
+-- Get inner container of scrollview.<br>
--- Inner container is the container of scrollview's children.<br>
+-- Inner container is a child of scrollview.<br>
--- return inner container.
+-- return Inner container pointer.
 -- @function [parent=#ScrollView] getInnerContainer 
 -- @param self
 -- @return Layout#Layout ret (return value: ccui.Layout)
@@ -68,15 +79,17 @@
         
 --------------------------------
 -- Changes scroll direction of scrollview.<br>
--- see Direction      Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll<br>
+-- see `Direction`<br>
--- param dir
+-- param dir Scroll direction enum.
 -- @function [parent=#ScrollView] setDirection 
 -- @param self
 -- @param #int dir
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Scroll inner container to top and left boundary of scrollview.
+-- Scroll inner container to top and left boundary of scrollview.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToTopLeft 
 -- @param self
 -- @param #float time
@@ -96,44 +109,48 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Changes inner container size of scrollview.<br>
+-- Change inner container size of scrollview.<br>
 -- Inner container size must be larger than or equal scrollview's size.<br>
--- param inner container size.
+-- param size Inner container size.
 -- @function [parent=#ScrollView] setInnerContainerSize 
 -- @param self
 -- @param #size_table size
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Gets inner container size of scrollview.<br>
+-- Get inner container size of scrollview.<br>
 -- Inner container size must be larger than or equal scrollview's size.<br>
--- return inner container size.
+-- return The inner container size.
 -- @function [parent=#ScrollView] getInnerContainerSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
--- 
+-- brief Query bounce state.<br>
+-- return True if bounce is enabled, false otherwise.
 -- @function [parent=#ScrollView] isBounceEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- Move inner container to vertical percent position of scrollview.
+-- Move inner container to vertical percent position of scrollview.<br>
+-- param A value between 0 and 100.
 -- @function [parent=#ScrollView] jumpToPercentVertical 
 -- @param self
 -- @param #float percent
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- 
+-- Add callback function which will be called  when scrollview event triggered.<br>
+-- param callback A callback function with type of `ccScrollViewCallback`.
 -- @function [parent=#ScrollView] addEventListener 
 -- @param self
 -- @param #function callback
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- 
+-- brief Toggle whether enable scroll inertia while scrolling.<br>
+-- param enabled True if enable inertia, false otherwise.
 -- @function [parent=#ScrollView] setInertiaScrollEnabled 
 -- @param self
 -- @param #bool enabled
@@ -146,7 +163,8 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Move inner container to horizontal percent position of scrollview.
+-- Move inner container to horizontal percent position of scrollview.<br>
+-- param A value between 0 and 100.
 -- @function [parent=#ScrollView] jumpToPercentHorizontal 
 -- @param self
 -- @param #float percent
@@ -159,7 +177,8 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- 
+-- brief Toggle bounce enabled when scroll to the edge.<br>
+-- param enabled True if enable bounce, false otherwise.
 -- @function [parent=#ScrollView] setBounceEnabled 
 -- @param self
 -- @param #bool enabled
@@ -172,7 +191,9 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Scroll inner container to left boundary of scrollview.
+-- Scroll inner container to left boundary of scrollview.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToLeft 
 -- @param self
 -- @param #float time
@@ -180,14 +201,18 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Move inner container to both direction percent position of scrollview.
+-- Move inner container to both direction percent position of scrollview.<br>
+-- param A value between 0 and 100.
 -- @function [parent=#ScrollView] jumpToPercentBothDirection 
 -- @param self
 -- @param #vec2_table percent
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Scroll inner container to vertical percent position of scrollview.
+-- Scroll inner container to vertical percent position of scrollview.<br>
+-- param percent A value between 0 and 100.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToPercentVertical 
 -- @param self
 -- @param #float percent
@@ -196,7 +221,9 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Scroll inner container to bottom boundary of scrollview.
+-- Scroll inner container to bottom boundary of scrollview.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToBottom 
 -- @param self
 -- @param #float time
@@ -204,7 +231,9 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Scroll inner container to bottom and right boundary of scrollview.
+-- Scroll inner container to bottom and right boundary of scrollview.<br>
+-- param time Time in seconds<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToBottomRight 
 -- @param self
 -- @param #float time
@@ -218,7 +247,9 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Scroll inner container to right boundary of scrollview.
+-- Scroll inner container to right boundary of scrollview.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToRight 
 -- @param self
 -- @param #float time
@@ -232,7 +263,9 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Scroll inner container to top and right boundary of scrollview.
+-- Scroll inner container to top and right boundary of scrollview.<br>
+-- param time Time in seconds.<br>
+-- param attenuated Whether scroll speed attenuate or not.
 -- @function [parent=#ScrollView] scrollToTopRight 
 -- @param self
 -- @param #float time
@@ -240,7 +273,8 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Allocates and initializes.
+-- Create an empty ScrollView.<br>
+-- return A ScrollView instance.
 -- @function [parent=#ScrollView] create 
 -- @param self
 -- @return ScrollView#ScrollView ret (return value: ccui.ScrollView)
@@ -271,7 +305,7 @@
 -- @return Node#Node ret (return value: cc.Node)
         
 --------------------------------
--- Returns the "class name" of widget.
+-- Return the "class name" of widget.
 -- @function [parent=#ScrollView] getDescription 
 -- @param self
 -- @return string#string ret (return value: string)
@@ -284,8 +318,8 @@
 -- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
         
 --------------------------------
--- Gets LayoutType.<br>
+-- Get the layout type for scrollview.<br>
--- see LayoutType<br>
+-- see `Layout::Type`<br>
 -- return LayoutType
 -- @function [parent=#ScrollView] getLayoutType 
 -- @param self
@@ -345,9 +379,9 @@
 -- @return long#long ret (return value: long)
         
 --------------------------------
--- Sets LayoutType.<br>
+-- Set layout type for scrollview.<br>
--- see LayoutType<br>
+-- see `Layout::Type`<br>
--- param LayoutType
+-- param type  Layout type enum.
 -- @function [parent=#ScrollView] setLayoutType 
 -- @param self
 -- @param #int type

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

@@ -5,181 +5,207 @@
 -- @parent_module ccui
 
 --------------------------------
--- 
+-- brief Toggle attach with IME.<br>
+-- param attach True if attach with IME, false otherwise.
 -- @function [parent=#TextField] setAttachWithIME 
 -- @param self
 -- @param #bool attach
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Query the font size.<br>
+-- return The integer font size.
 -- @function [parent=#TextField] getFontSize 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- Query the content of TextField.<br>
+-- return The string value of TextField.
 -- @function [parent=#TextField] getString 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+-- brief Change password style text.<br>
+-- param styleText The styleText for password mask, the default value is "*".
 -- @function [parent=#TextField] setPasswordStyleText 
 -- @param self
 -- @param #char styleText
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Whether it is ready to delete backward in TextField.<br>
+-- return True is the delete backward is enabled, false otherwise.
 -- @function [parent=#TextField] getDeleteBackward 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Get the placeholder of TextField.<br>
+-- return A placeholder string.
 -- @function [parent=#TextField] getPlaceHolder 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+-- brief Query whether the IME is attached or not.<br>
+-- return True if IME is attached, false otherwise.
 -- @function [parent=#TextField] getAttachWithIME 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Change the font name of TextField.<br>
+-- param name The font name string.
 -- @function [parent=#TextField] setFontName 
 -- @param self
 -- @param #string name
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Whether it is ready to get the inserted text or not.<br>
+-- return True if the insert text is ready, false otherwise.
 -- @function [parent=#TextField] getInsertText 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Toggle enable insert text mode<br>
+-- param insertText True if enable insert text, false otherwise.
 -- @function [parent=#TextField] setInsertText 
 -- @param self
 -- @param #bool insertText
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- Change content of TextField.<br>
+-- param text A string content.
 -- @function [parent=#TextField] setString 
 -- @param self
 -- @param #string text
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Query whether IME is detached or not.<br>
+-- return True if IME is detached, false otherwise.
 -- @function [parent=#TextField] getDetachWithIME 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Change the vertical text alignment.<br>
+-- param alignment A alignment arguments in @see `TextVAlignment`.
 -- @function [parent=#TextField] setTextVerticalAlignment 
 -- @param self
 -- @param #int alignment
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- Add a event listener to TextField, when some predefined event happens, the callback will be called.<br>
+-- param callback A callback function with type of `ccTextFieldCallback`.
 -- @function [parent=#TextField] addEventListener 
 -- @param self
 -- @param #function callback
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Detach the IME.
 -- @function [parent=#TextField] didNotSelectSelf 
 -- @param self
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Query the TextField's font name.<br>
+-- return The font name string.
 -- @function [parent=#TextField] getFontName 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+-- brief Change the text area size.<br>
+-- param size A delimitation zone.
 -- @function [parent=#TextField] setTextAreaSize 
 -- @param self
 -- @param #size_table size
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Attach the IME for inputing.
 -- @function [parent=#TextField] attachWithIME 
 -- @param self
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Query the input string length.<br>
+-- return A integer length value.
 -- @function [parent=#TextField] getStringLength 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- brief Get the the renderer size in auto mode.<br>
+-- return A delimitation zone.
 -- @function [parent=#TextField] getAutoRenderSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
--- 
+-- brief Toggle enable password input mode.<br>
+-- param enable True if enable password input mode, false otherwise.
 -- @function [parent=#TextField] setPasswordEnabled 
 -- @param self
 -- @param #bool enable
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Query the placeholder string color.<br>
+-- return The color of placeholder.
 -- @function [parent=#TextField] getPlaceHolderColor 
 -- @param self
 -- @return color4b_table#color4b_table ret (return value: color4b_table)
         
 --------------------------------
--- 
+-- brief Query the password style text.<br>
+-- return A password style text.
 -- @function [parent=#TextField] getPasswordStyleText 
 -- @param self
 -- @return char#char ret (return value: char)
         
 --------------------------------
--- 
+-- brief Toggle maximize length enable<br>
+-- param enable True if enable maximize length, false otherwise.
 -- @function [parent=#TextField] setMaxLengthEnabled 
 -- @param self
 -- @param #bool enable
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Query whether password is enabled or not.<br>
+-- return True if password is enabled, false otherwise.
 -- @function [parent=#TextField] isPasswordEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Toggle enable delete backward mode.<br>
+-- param deleteBackward True is delete backward is enabled, false otherwise.
 -- @function [parent=#TextField] setDeleteBackward 
 -- @param self
 -- @param #bool deleteBackward
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Change font size of TextField.<br>
+-- param size The integer font size.
 -- @function [parent=#TextField] setFontSize 
 -- @param self
 -- @param #int size
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Set placeholder of TextField.<br>
+-- param value The string value of placeholder.
 -- @function [parent=#TextField] setPlaceHolder 
 -- @param self
 -- @param #string value
@@ -194,61 +220,71 @@
 -- @return TextField#TextField self (return value: ccui.TextField)
 
 --------------------------------
--- 
+-- brief Change horizontal text alignment.<br>
+-- param alignment A alignment arguments in @see `TextHAlignment`.
 -- @function [parent=#TextField] setTextHorizontalAlignment 
 -- @param self
 -- @param #int alignment
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Change the text color.<br>
+-- param textColor The color value in `Color4B`.
 -- @function [parent=#TextField] setTextColor 
 -- @param self
 -- @param #color4b_table textColor
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Query maximize input length of TextField.<br>
+-- return The integer value of maximize input length.
 -- @function [parent=#TextField] getMaxLength 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- brief Query whether max length is enabled or not.<br>
+-- return True if maximize length is enabled, false otherwise.
 -- @function [parent=#TextField] isMaxLengthEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- brief Toggle detach with IME.<br>
+-- param detach True if detach with IME, false otherwise.
 -- @function [parent=#TextField] setDetachWithIME 
 -- @param self
 -- @param #bool detach
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Toggle enable touch area.<br>
+-- param enable True if enable touch area, false otherwise.
 -- @function [parent=#TextField] setTouchAreaEnabled 
 -- @param self
 -- @param #bool enable
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Change maximize input length limitation.<br>
+-- param length A character count in integer.
 -- @function [parent=#TextField] setMaxLength 
 -- @param self
 -- @param #int length
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Set the touch size<br>
+-- The touch size is used for @see `hitTest`.<br>
+-- param size A delimitation zone.
 -- @function [parent=#TextField] setTouchSize 
 -- @param self
 -- @param #size_table size
 -- @return TextField#TextField self (return value: ccui.TextField)
         
 --------------------------------
--- 
+-- brief Get current touch size of TextField.<br>
+-- return The TextField's touch size.
 -- @function [parent=#TextField] getTouchSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
@@ -302,7 +338,7 @@
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
--- 
+-- brief Default constructor.
 -- @function [parent=#TextField] TextField 
 -- @param self
 -- @return TextField#TextField self (return value: ccui.TextField)

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

@@ -22,7 +22,7 @@
 -- @return TileMapAtlas#TileMapAtlas self (return value: cc.TileMapAtlas)
         
 --------------------------------
---  returns a tile from position x,y.<br>
+-- Returns a tile from position x,y.<br>
 -- For the moment only channel R is used
 -- @function [parent=#TileMapAtlas] getTileAt 
 -- @param self

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

@@ -5,6 +5,7 @@
 -- @parent_module ccui
 
 --------------------------------
+-- Toggle layout component enable.<br>
 -- param enable Layout Component of a widget<br>
 -- return void
 -- @function [parent=#Widget] setLayoutComponentEnabled 
@@ -21,13 +22,15 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- 
+-- Get the user defined widget size.<br>
+-- return User defined size.
 -- @function [parent=#Widget] getCustomSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
         
 --------------------------------
--- 
+-- Gets the left boundary position of this widget in parent's coordination system.<br>
+-- return The left boundary position of this widget.
 -- @function [parent=#Widget] getLeftBoundary 
 -- @param self
 -- @return float#float ret (return value: float)
@@ -41,14 +44,15 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- callbackName getter and setter.
+-- Set callback name.<br>
+-- param callbackName A string representation of callback name.
 -- @function [parent=#Widget] setCallbackName 
 -- @param self
 -- @param #string callbackName
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- Gets the Virtual Renderer of widget.<br>
+-- Gets the inner Renderer node of widget.<br>
 -- For example, a button's Virtual Renderer is it's texture renderer.<br>
 -- return Node pointer.
 -- @function [parent=#Widget] getVirtualRenderer 
@@ -57,6 +61,7 @@
         
 --------------------------------
 -- brief Allow widget touch events to propagate to its parents. Set false will disable propagation<br>
+-- param isPropagate  True to allow propagation, false otherwise.<br>
 -- since v3.3
 -- @function [parent=#Widget] setPropagateTouchEvents 
 -- @param self
@@ -64,14 +69,15 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
+-- Query whether unify size enable state. <br>
 -- return true represent the widget use Unify Size, false represent the widget couldn't use Unify Size
 -- @function [parent=#Widget] isUnifySizeEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- Returns size percent of widget<br>
+-- Get size percent of widget.<br>
--- return size percent
+-- return Percent size.
 -- @function [parent=#Widget] getSizePercent 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
@@ -85,7 +91,9 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
+-- Toggle widget swallow touch option.<br>
 -- brief Specify widget to swallow touches or not<br>
+-- param swallow True to swallow touch, false otherwise.<br>
 -- since v3.3
 -- @function [parent=#Widget] setSwallowTouches 
 -- @param self
@@ -93,7 +101,9 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- 
+-- Get the content size of widget.<br>
+-- warning This API exists mainly for keeping back compatibility.<br>
+-- return 
 -- @function [parent=#Widget] getLayoutSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
@@ -109,7 +119,7 @@
         
 --------------------------------
 -- Changes the position type of the widget<br>
--- see PositionType<br>
+-- see `PositionType`<br>
 -- param type  the position type of widget
 -- @function [parent=#Widget] setPositionType 
 -- @param self
@@ -118,13 +128,14 @@
         
 --------------------------------
 -- Query whether the widget ignores user deinfed content size or not<br>
--- return bool
+-- return True means ignore user defined content size, false otherwise.
 -- @function [parent=#Widget] isIgnoreContentAdaptWithSize 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Get the virtual renderer's size<br>
+-- return Widget virtual renderer size.
 -- @function [parent=#Widget] getVirtualRendererSize 
 -- @param self
 -- @return size_table#size_table ret (return value: size_table)
@@ -147,21 +158,23 @@
         
 --------------------------------
 -- Gets the position type of the widget<br>
--- see PositionType<br>
+-- see `PositionType`<br>
 -- return type  the position type of widget
 -- @function [parent=#Widget] getPositionType 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- Gets the top boundary position of this widget in parent's coordination system.<br>
+-- return The top boundary position of this widget.
 -- @function [parent=#Widget] getTopBoundary 
 -- @param self
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- Note: when you set _ignoreSize to true, no matther you call setContentSize or not, <br>
+-- Toggle whether ignore user defined content size for widget.<br>
--- the widget size is always equal to the return value of the member function getVirtualRendererSize.<br>
+-- Set true will ignore user defined content size which means <br>
+-- the widget size is always equal to the return value of  @see `getVirtualRendererSize`.<br>
 -- param ignore, set member variabl _ignoreSize to ignore
 -- @function [parent=#Widget] ignoreContentAdaptWithSize 
 -- @param self
@@ -181,20 +194,22 @@
 -- @return Widget#Widget ret (return value: ccui.Widget)
         
 --------------------------------
--- Determines if the widget is enabled<br>
+-- Determines if the widget is enabled or not.<br>
 -- return true if the widget is enabled, false if the widget is disabled.
 -- @function [parent=#Widget] isEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
+-- Query whether widget is focused or not.<br>
 -- return  whether the widget is focused or not
 -- @function [parent=#Widget] isFocused 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Gets the touch began point of widget when widget is selected.<br>
+-- return the touch began point.
 -- @function [parent=#Widget] getTouchBeganPosition 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
@@ -207,31 +222,35 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Query callback name.<br>
+-- return The callback name.
 -- @function [parent=#Widget] getCallbackName 
 -- @param self
 -- @return string#string ret (return value: string)
         
 --------------------------------
--- 
+-- Get the action tag.<br>
+-- return Action tag.
 -- @function [parent=#Widget] getActionTag 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- Gets world position of widget.<br>
+-- Gets position of widget in world space.<br>
--- return world position of widget.
+-- return Position of widget in world space.
 -- @function [parent=#Widget] getWorldPosition 
 -- @param self
 -- @return vec2_table#vec2_table ret (return value: vec2_table)
         
 --------------------------------
+-- Query widget's focus enable state.<br>
 -- return true represent the widget could accept focus, false represent the widget couldn't accept focus
 -- @function [parent=#Widget] isFocusEnabled 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
+-- Toggle widget focus status.<br>
 -- param focus  pass true to let the widget get focus or pass false to let the widget lose focus<br>
 -- return void
 -- @function [parent=#Widget] setFocused 
@@ -240,7 +259,8 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- 
+-- Set the tag of action.<br>
+-- param tag  A integer tag value.
 -- @function [parent=#Widget] setActionTag 
 -- @param self
 -- @param #int tag
@@ -266,15 +286,17 @@
 --------------------------------
 -- Sets whether the widget is enabled<br>
 -- true if the widget is enabled, widget may be touched , false if the widget is disabled, widget cannot be touched.<br>
--- The default value is true, a widget is default to enabled<br>
+-- Note: If you want to change the widget's appearance  to disabled state, you should also call @see `setBright(false)`.<br>
--- param enabled
+-- The default value is true, a widget is default to enable touch.<br>
+-- param enabled Set to true to enable touch, false otherwise.
 -- @function [parent=#Widget] setEnabled 
 -- @param self
 -- @param #bool enabled
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- 
+-- Gets the right boundary position of this widget in parent's coordination system.<br>
+-- return The right boundary position of this widget.
 -- @function [parent=#Widget] getRightBoundary 
 -- @param self
 -- @return float#float ret (return value: float)
@@ -299,12 +321,14 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- 
+-- Create a new widget copy of the original one.<br>
+-- return A cloned widget copy of original.
 -- @function [parent=#Widget] clone 
 -- @param self
 -- @return Widget#Widget ret (return value: ccui.Widget)
         
 --------------------------------
+-- Allow widget to accept focus.<br>
 -- param enable pass true/false to enable/disable the focus ability of a widget<br>
 -- return void
 -- @function [parent=#Widget] setFocusEnabled 
@@ -313,7 +337,8 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- 
+-- Gets the bottom boundary position of this widget in parent's coordination system.<br>
+-- return The bottom boundary position of this widget.
 -- @function [parent=#Widget] getBottomBoundary 
 -- @param self
 -- @return float#float ret (return value: float)
@@ -326,7 +351,8 @@
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- param enable Unify Size of a widget<br>
+-- Toggle use unify size.<br>
+-- param enable True to use unify size, false otherwise.<br>
 -- return void
 -- @function [parent=#Widget] setUnifySizeEnabled 
 -- @param self
@@ -335,27 +361,31 @@
         
 --------------------------------
 -- Return whether the widget is propagate touch events to its parents or not<br>
+-- return whether touch event propagation is allowed or not.<br>
 -- since v3.3
 -- @function [parent=#Widget] isPropagateTouchEvents 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Return a current focused widget in your UI scene.<br>
+-- No matter what widget object you call this method on , it will return you the exact one focused widget.
 -- @function [parent=#Widget] getCurrentFocusedWidget 
 -- @param self
 -- @return Widget#Widget ret (return value: ccui.Widget)
         
 --------------------------------
--- Checks a point if is in widget's space<br>
+-- Checks a point is in widget's content space.<br>
--- param point<br>
+-- This function is used for determining touch area of widget.<br>
--- return true if the point is in widget's space, flase otherwise.
+-- param pt The point in `Vec2`.<br>
+-- return true if the point is in widget's content space, flase otherwise.
 -- @function [parent=#Widget] hitTest 
 -- @param self
 -- @param #vec2_table pt
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
+-- Query whether layout component is enabled or not. <br>
 -- return true represent the widget use Layout Component, false represent the widget couldn't use Layout Component.
 -- @function [parent=#Widget] isLayoutComponentEnabled 
 -- @param self
@@ -383,14 +413,15 @@
         
 --------------------------------
 -- Gets the size type of widget.<br>
--- see SizeType<br>
+-- see `SizeType`<br>
 -- param type that is widget's size type
 -- @function [parent=#Widget] getSizeType 
 -- @param self
 -- @return int#int ret (return value: int)
         
 --------------------------------
--- 
+-- Query callback type.<br>
+-- return Callback type string.
 -- @function [parent=#Widget] getCallbackType 
 -- @param self
 -- @return string#string ret (return value: string)
@@ -411,10 +442,9 @@
         
 --------------------------------
 -- Returns the flag which indicates whether the widget is flipped horizontally or not.<br>
--- It only flips the texture of the widget, and not the texture of the widget's children.<br>
+-- It not only flips the texture of the widget, but also the texture of the widget's children.<br>
--- Also, flipping the texture doesn't alter the anchorPoint.<br>
+-- Also, flipping relies on widget's anchor point.<br>
--- If you want to flip the anchorPoint too, and/or to flip the children too use:<br>
+-- Internally, it just use setScaleX(-1) to flip the widget.<br>
--- widget->setScaleX(sprite->getScaleX() * -1);<br>
 -- return true if the widget is flipped horizaontally, false otherwise.
 -- @function [parent=#Widget] isFlippedX 
 -- @param self
@@ -422,17 +452,18 @@
         
 --------------------------------
 -- Return the flag which indicates whether the widget is flipped vertically or not.<br>
--- It only flips the texture of the widget, and not the texture of the widget's children.<br>
+-- It not only flips the texture of the widget, but also the texture of the widget's children.<br>
--- Also, flipping the texture doesn't alter the anchorPoint.<br>
+-- Also, flipping relies on widget's anchor point.<br>
--- If you want to flip the anchorPoint too, and/or to flip the children too use:<br>
+-- Internally, it just use setScaleY(-1) to flip the widget.<br>
--- widget->setScaleY(widget->getScaleY() * -1);<br>
 -- return true if the widget is flipped vertically, flase otherwise.
 -- @function [parent=#Widget] isFlippedY 
 -- @param self
 -- @return bool#bool ret (return value: bool)
         
 --------------------------------
--- 
+-- Checks a point if in parent's area.<br>
+-- param point A point in `Vec2`.<br>
+-- return true if the point is in parent's area, flase otherwise.
 -- @function [parent=#Widget] isClippingParentContainsPoint 
 -- @param self
 -- @param #vec2_table pt
@@ -440,7 +471,7 @@
         
 --------------------------------
 -- Changes the size type of widget.<br>
--- see SizeType<br>
+-- see `SizeType`<br>
 -- param type that is widget's size type
 -- @function [parent=#Widget] setSizeType 
 -- @param self
@@ -457,7 +488,8 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- callbackType getter and setter.
+-- Set callback type.<br>
+-- param callbackType A string representation of callback type.
 -- @function [parent=#Widget] setCallbackType 
 -- @param self
 -- @param #string callbackType
@@ -465,6 +497,7 @@
         
 --------------------------------
 -- Return whether the widget is swallowing touch or not<br>
+-- return Whether touch is swallowed.<br>
 -- since v3.3
 -- @function [parent=#Widget] isSwallowTouches 
 -- @param self
@@ -478,7 +511,7 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- Allocates and initializes a widget.
+-- Create and return a empty Widget instance pointer.
 -- @function [parent=#Widget] create 
 -- @param self
 -- @return Widget#Widget ret (return value: ccui.Widget)
@@ -510,7 +543,8 @@
 -- @return float#float ret (return value: float)
         
 --------------------------------
--- Returns the "class name" of widget.
+-- Returns the string representation of widget class name<br>
+-- return get the class description.
 -- @function [parent=#Widget] getDescription 
 -- @param self
 -- @return string#string ret (return value: string)
@@ -526,7 +560,7 @@
 
 --------------------------------
 -- Changes the position (x,y) of the widget in OpenGL coordinates<br>
--- Usually we use p(x,y) to compose Vec2 object.<br>
+-- Usually we use p(x,y) to compose a Vec2 object.<br>
 -- The original point (0,0) is at the left-bottom corner of screen.<br>
 -- param position  The position (x,y) of the widget in OpenGL coordinates
 -- @function [parent=#Widget] setPosition 
@@ -535,7 +569,8 @@
 -- @return Widget#Widget self (return value: ccui.Widget)
         
 --------------------------------
--- 
+-- Changes the size that is widget's size<br>
+-- param contentSize A content size in `Size`.
 -- @function [parent=#Widget] setContentSize 
 -- @param self
 -- @param #size_table contentSize