Merge pull request #11126 from samuele3hu/v3_5_test

[ci skip]Update comments of some header files

cocos/scripting/lua-bindings/manual/LuaBasicConversions.cpp

@@ -1925,7 +1925,7 @@ bool luaval_to_mesh_vertex_attrib(lua_State* L, int lo, cocos2d::MeshVertexAttri
         ret->type  = (GLenum)lua_tonumber(L, -1);
         lua_pop(L,1);
         
-        lua_pushstring(L, "vertexAttrib");          /* L: paramStack key */
+        lua_pushstring(L, "attribSizeBytes");       /* L: paramStack key */
         lua_gettable(L,lo);                         /* L: paramStack paramStack[lo][key] */
         ret->type  = (GLenum)lua_tonumber(L, -1);
         lua_pop(L,1);
@@ -2304,10 +2304,10 @@ void affinetransform_to_luaval(lua_State* L,const AffineTransform& inValue)
     lua_pushnumber(L, (lua_Number) inValue.d);               /* L: table key value*/
     lua_rawset(L, -3);                                  /* table[key] = value, L: table */
     lua_pushstring(L, "tx");                             /* L: table key */
-    lua_pushnumber(L, (lua_Number) inValue.d);               /* L: table key value*/
+    lua_pushnumber(L, (lua_Number) inValue.tx);               /* L: table key value*/
     lua_rawset(L, -3);                                  /* table[key] = value, L: table */
     lua_pushstring(L, "ty");                             /* L: table key */
-    lua_pushnumber(L, (lua_Number) inValue.d);               /* L: table key value*/
+    lua_pushnumber(L, (lua_Number) inValue.ty);               /* L: table key value*/
     lua_rawset(L, -3);                                  /* table[key] = value, L: table */
 }
 

cocos/scripting/lua-bindings/manual/cocosbuilder/lua_cocos2dx_cocosbuilder_manual.h

@@ -33,6 +33,17 @@ extern "C" {
 #endif
 
 TOLUA_API int register_all_cocos2dx_cocosbuilder_manual(lua_State* tolua_S);
+
+/**
+ * Call this function can import the lua bindings for the cocosbuilder module.
+ * After registering, we could call the related cocosbuilder code conveniently in the lua.eg,.cc.CCBProxy:create().
+ * If you don't want to use the cocosbuilder module in the lua, you only don't call this registering function.
+ * If you don't register the cocosbuilder module, the package size would become smaller .
+ * The current mechanism,this registering function is called in the lua_module_register.h
+ *
+ * @lua NA
+ * @js NA
+ */
 TOLUA_API int register_cocosbuilder_module(lua_State* tolua_S);
 
 #endif // #ifndef COCOS_SCRIPTING_LUA_BINDINGS_MANUAL_LUA_COCOS2DX_COCOSBUILDER_H

cocos/scripting/lua-bindings/manual/cocosdenshion/lua_cocos2dx_cocosdenshion_manual.h

@@ -32,6 +32,17 @@ extern "C" {
 }
 #endif
 
+/**
+ * Call this function can import the lua bindings for the cocosdenshion module.
+ * After registering, we could call the related cocosdenshion code conveniently in the lua.eg,.cc.SimpleAudioEngine:getInstance():stopAllEffects().
+ * In current mechanism, most bindings function of SimpleAudioEngine are wrapped in the Lua script file named AudioEngine.lua by more friednly modes.
+ * If you don't want to use the cocosdenshion module in the lua, you only don't call this registering function.
+ * If you don't register the cocosdenshion module, the package size would become smaller .
+ * The current mechanism,this registering function is called in the lua_module_register.h
+ *
+ * @lua NA
+ * @js NA
+ */
 TOLUA_API int  register_cocosdenshion_module(lua_State* L);
 
 

cocos/scripting/lua-bindings/manual/extension/lua_cocos2dx_extension_manual.h

@@ -32,9 +32,20 @@ extern "C" {
 }
 #endif
 
-TOLUA_API int  register_all_cocos2dx_extension_manual(lua_State* tolua_S);
+/**
+ * Call this function can import the lua bindings for classes in the `cocos2d::extension` namespace like cocos2d::extension::Control, cocos2d::extension::ControlHuePicker, and so on.
+ * After registering, we could call the related cocosbuilder code conveniently in the lua.eg,.cc.Control:create().
+ * If you don't want to use the extension module in the lua, you only don't call this registering function.
+ * If you don't register the extension module, the package size would become smaller .
+ * The current mechanism,this registering function is called in the lua_module_register.h
+ *
+ * @lua NA
+ * @js NA
+ */
 TOLUA_API int  register_extension_module(lua_State* tolua_S);
 
+TOLUA_API int  register_all_cocos2dx_extension_manual(lua_State* tolua_S);
+
 struct LuaAssetsManagerEventData
 {
     int value;

cocos/scripting/lua-bindings/manual/network/Lua_web_socket.h

@@ -35,6 +35,8 @@ extern "C" {
 #endif
 
 #include "network/WebSocket.h"
+
+///@cond
 class LuaWebSocket: public cocos2d::network::WebSocket,public cocos2d::network::WebSocket::Delegate
 {
 public:
@@ -55,6 +57,7 @@ public:
 
 TOLUA_API int tolua_web_socket_open(lua_State* tolua_S);
 TOLUA_API int register_web_socket_manual(lua_State* tolua_S);
+///@endcond
 
 #endif //(CC_TARGET_PLATFORM == CC_PLATFORM_IOS ...
 

cocos/scripting/lua-bindings/manual/network/lua_cocos2dx_network_manual.h

@@ -32,6 +32,16 @@ extern "C" {
 }
 #endif
 
+/**
+ * Call this function can import the lua bindings for the network module.
+ * After registering, we could call the related network code conveniently in the lua.eg,.cc.WebSocket:create("ws://echo.websocket.org").
+ * If you don't want to use the network module in the lua, you only don't call this registering function.
+ * If you don't register the network module, the package size would become smaller .
+ * The current mechanism,this registering function is called in the lua_module_register.h
+ *
+ * @lua NA
+ * @js NA
+ */
 TOLUA_API int register_network_module(lua_State* L);
 
 #endif //#ifndef __COCOS_SCRIPTING_LUA_BINDINGS_MANUAL_NETWORK_LUA_COCOS2DX_NETWORK_MANUAL_H__

cocos/scripting/lua-bindings/manual/network/lua_extensions.h

@@ -14,7 +14,9 @@ extern "C" {
 
 #include "lauxlib.h"
 
+/// @cond
 void LUA_EXTENSIONS_DLL luaopen_lua_extensions(lua_State *L);
+/// @endcond
     
 #if __cplusplus
 }

cocos/scripting/lua-bindings/manual/network/lua_xml_http_request.h

@@ -37,6 +37,7 @@ extern "C" {
 
 #include "network/HttpClient.h"
 
+///@cond
 class LuaMinXmlHttpRequest : public cocos2d::Ref
 {
 public:
@@ -129,5 +130,5 @@ private:
 };
 
 TOLUA_API int register_xml_http_request(lua_State* L);
-
+///@endcond
 #endif //#ifndef __COCOS_SCRIPTING_LUA_BINDINGS_LUA_XML_HTTP_REQUEST_H__

cocos/scripting/lua-bindings/manual/spine/LuaSkeletonAnimation.h

@@ -27,6 +27,7 @@
 #define LUASKELETONANIMATION_H_
 #include "spine-cocos2dx.h"
 
+/// @cond
 class LuaSkeletonAnimation: public spine::SkeletonAnimation {
 public:
 	static LuaSkeletonAnimation* createWithFile (const char* skeletonDataFile, const char* atlasFile, float scale = 1);
@@ -35,5 +36,5 @@ public:
 
 	virtual ~LuaSkeletonAnimation();
 };
-
+/// @endcond
 #endif /* LUASKELETONANIMATION_H_ */