Browse Source

Modify comment in LuaScript module.

aster2013 12 years ago
parent
commit
6dba57e5ad

+ 1 - 1
Source/Engine/LuaScript/LuaFile.cpp

@@ -101,7 +101,7 @@ bool LuaFile::LoadChunk(lua_State* luaState)
 
     int top = lua_gettop(luaState);
 
-    // Get file name without extension.
+    // Get file base name
     String name = GetName();
     unsigned extPos = name.FindLast('.');
     if (extPos != String::NPOS)

+ 16 - 12
Source/Engine/LuaScript/LuaScript.cpp

@@ -244,11 +244,11 @@ void LuaScript::ScriptUnsubscribeFromEvents(void* sender)
 
 void LuaScript::RegisterLoader()
 {
-    // Get package.loaders table.
+    // Get package.loaders table
     lua_getglobal(luaState_, "package");
     lua_getfield(luaState_, -1, "loaders");
 
-    // Add our loader to the end of the table
+    // Add LuaScript::Loader to the end of the table
     lua_pushinteger(luaState_, lua_objlen(luaState_, -1) + 1);
     lua_pushcfunction(luaState_, &LuaScript::Loader);
     lua_settable(luaState_, -3);
@@ -269,15 +269,15 @@ int LuaScript::Loader(lua_State* L)
     if (!cache)
         return 0;
 
-    // Get module name.
+    // Get module name
     const char* name = luaL_checkstring(L, 1);
 
-    // Get Luc file from module name.
+    // Get Luc file
     LuaFile* lucFile = cache->GetResource<LuaFile>(String(name) + ".luc");
     if (lucFile)
         return lucFile->LoadChunk(L) ? 1 : 0;
 
-    // Get Lua file from module name.
+    // Get Lua file
     LuaFile* luaFile = cache->GetResource<LuaFile>(String(name) + ".lua");
     if (luaFile)
         return luaFile->LoadChunk(L) ? 1 : 0;
@@ -306,21 +306,25 @@ int LuaScript::Print(lua_State *L)
     for (int i = 1; i <= n; i++)
     {
         const char *s;
-        lua_pushvalue(L, -1);  /* function to be called */
-        lua_pushvalue(L, i);   /* value to print */
+        // Function to be called
+        lua_pushvalue(L, -1);
+        // Value to print
+        lua_pushvalue(L, i);
         lua_call(L, 1, 1);
-        s = lua_tostring(L, -1);  /* get result */
+        // Get result
+        s = lua_tostring(L, -1);
         if (s == NULL)
             return luaL_error(L, LUA_QL("tostring") " must return a string to " LUA_QL("print"));
 
         if (i > 1)
-            string.Append("    "); // fputs("\t", stdout);
+            string.Append("    ");
 
-        string.Append(s); // fputs(s, stdout);
-        lua_pop(L, 1);  /* pop result */
+        string.Append(s);
+        // Pop result
+        lua_pop(L, 1);
     }
 
-    LOGRAW("Lua: " + string); // fputs("\n", stdout);
+    LOGRAW("Lua: " + string);
 
     return 0;
 }

+ 2 - 2
Source/Engine/LuaScript/LuaScriptInstance.cpp

@@ -160,7 +160,7 @@ void LuaScriptInstance::SetScriptObjectType(const String& scriptObjectType)
     scriptObjectType_ = scriptObjectType;
     scriptObjectRef_ = luaL_ref(luaState_, LUA_REGISTRYINDEX);
 
-    // Find script object method refs.
+    // Find script object method refs
     FindScriptObjectMethodRefs();
 }
 
@@ -450,7 +450,7 @@ void LuaScriptInstance::ReleaseObject()
     if (IsEnabledEffective())
         UnsubscribeFromScriptMethodEvents();
 
-    // Unref script object.
+    // Unref script object
     luaL_unref(luaState_, LUA_REGISTRYINDEX, scriptObjectRef_);
     scriptObjectRef_ = LUA_REFNIL;
 

+ 10 - 10
Source/Engine/LuaScript/ToluaUtils.cpp

@@ -36,7 +36,7 @@ const char* tolua_tourho3dstring(lua_State* L, int narg, const String& str)
     return tolua_tourho3dstring(L, narg, str.CString());
 }
 
-// Lua state to context mapping.
+// Lua state to context mapping
 static HashMap<void*, Context*> contextMapping;
 
 void SetContext(lua_State* L, Context* context)
@@ -190,7 +190,7 @@ template<> void* ToluaToPODVector<unsigned>(lua_State* L, int narg, void* def)
     return &result;
 }
 
-template<> int ToluaPushPODVector<int>(lua_State* L, void* data, const char* /*type*/)
+template<> int ToluaPushPODVector<int>(lua_State* L, void* data, const char*)
 {
     const PODVector<int>& vector = *((const PODVector<int>*)data);
     lua_newtable(L);
@@ -203,7 +203,7 @@ template<> int ToluaPushPODVector<int>(lua_State* L, void* data, const char* /*t
     return 1;
 }
 
-template<> int ToluaPushPODVector<unsigned>(lua_State* L, void* data, const char* /*type*/)
+template<> int ToluaPushPODVector<unsigned>(lua_State* L, void* data, const char*)
 {
     const PODVector<unsigned>& vector = *((const PODVector<unsigned>*)data);
     lua_newtable(L);
@@ -216,7 +216,7 @@ template<> int ToluaPushPODVector<unsigned>(lua_State* L, void* data, const char
     return 1;
 }
 
-template<> int ToluaPushPODVector<SoundSource*>(lua_State* L, void* data, const char* /*type*/)
+template<> int ToluaPushPODVector<SoundSource*>(lua_State* L, void* data, const char*)
 {
     const PODVector<SoundSource*>& vector = *((const PODVector<SoundSource*>*)data);
     lua_newtable(L);
@@ -228,7 +228,7 @@ template<> int ToluaPushPODVector<SoundSource*>(lua_State* L, void* data, const
     return 1;
 }
 
-template<> int ToluaPushPODVector<UIElement*>(lua_State* L, void* data, const char* /*type*/)
+template<> int ToluaPushPODVector<UIElement*>(lua_State* L, void* data, const char*)
 {
     const PODVector<UIElement*>& vector = *((const PODVector<UIElement*>*)data);
     lua_newtable(L);
@@ -255,27 +255,27 @@ template<typename T> int tolua_pushurho3dpodvectorusertype(lua_State* L, const P
     return 1;
 }
 
-template<> int ToluaPushPODVector<Vector3>(lua_State* L, void* data, const char* /*type*/)
+template<> int ToluaPushPODVector<Vector3>(lua_State* L, void* data, const char*)
 {
     return tolua_pushurho3dpodvectorusertype(L, *((const PODVector<Vector3>*)data), "Vector3");
 }
 
-template<> int ToluaPushPODVector<IntVector2>(lua_State* L, void* data, const char* /*type*/)
+template<> int ToluaPushPODVector<IntVector2>(lua_State* L, void* data, const char*)
 {
     return tolua_pushurho3dpodvectorusertype(L, *((const PODVector<IntVector2>*)data), "IntVector2");
 }
 
-template<> int ToluaPushPODVector<OctreeQueryResult>(lua_State* L, void* data, const char* /*type*/)
+template<> int ToluaPushPODVector<OctreeQueryResult>(lua_State* L, void* data, const char*)
 {
     return tolua_pushurho3dpodvectorusertype(L, *((const PODVector<OctreeQueryResult>*)data), "OctreeQueryResult");
 }
 
-template<> int ToluaPushPODVector<PhysicsRaycastResult>(lua_State* L, void* data, const char* /*type*/)
+template<> int ToluaPushPODVector<PhysicsRaycastResult>(lua_State* L, void* data, const char*)
 {
     return tolua_pushurho3dpodvectorusertype(L, *((const PODVector<PhysicsRaycastResult>*)data), "PhysicsRaycastResult");
 }
 
-template<> int ToluaPushPODVector<RayQueryResult>(lua_State* L, void* data, const char* /*type*/)
+template<> int ToluaPushPODVector<RayQueryResult>(lua_State* L, void* data, const char*)
 {
     return tolua_pushurho3dpodvectorusertype(L, *((const PODVector<RayQueryResult>*)data), "RayQueryResult");
 }

+ 10 - 13
Source/Engine/LuaScript/ToluaUtils.h

@@ -60,7 +60,7 @@ template<typename T> int ToluaNewObject(lua_State* tolua_S)
     tolua_pushusertype(tolua_S, (void*)object,T::GetTypeNameStatic().CString());
     return 1;
 }
-/// Create object with GC.
+/// Create object with garbage collection.
 template<typename T> int ToluaNewObjectGC(lua_State* tolua_S)
 {
     T* object = Mtolua_new(T(GetContext(tolua_S)));
@@ -77,14 +77,14 @@ template<typename T> int ToluaGetSubsystem(lua_State* tolua_S)
     return 1;
 }
 
-/// Check Lua table is Vector<T>.
+/// Check is Vector<T>.
 template<typename T> int ToluaIsVector(lua_State* L, int lo, const char* type, int def, tolua_Error* err);
-/// Check Lua table is Vector<String>.
+/// Check is Vector<String>.
 template<> int ToluaIsVector<String>(lua_State* L, int lo, const char* type, int def, tolua_Error* err);
 
-/// Convert Lua table to Vector<T>.
+/// Convert to Vector<T>.
 template<typename T> void* ToluaToVector(lua_State* L, int narg, void* def);
-/// Convert Lua table to Vector<String>.
+/// Convert to Vector<String>.
 template<> void* ToluaToVector<String>(lua_State* L, int narg, void* def);
 
 /// Push Vector<T> to Lua as a table.
@@ -92,14 +92,14 @@ template<typename T> int ToluaPushVector(lua_State*L, void* data, const char* ty
 /// Push Vector<String> to Lua as a table.
 template<> int ToluaPushVector<String>(lua_State* L, void* data, const char* type);
 
-/// Check Lua table is Vector<T>.
+/// Check is PODVector<T>.
 template<typename T> int ToluaIsPODVector(lua_State* L, int lo, const char* type, int def, tolua_Error* err);
-/// Check Lua table is Vector<unsigned>.
+/// Check is PODVector<unsigned>.
 template<> int ToluaIsPODVector<unsigned>(lua_State* L, int lo, const char* type, int def, tolua_Error* err);
 
-/// Convert Lua table to PODVector<T>.
+/// Convert to PODVector<T>.
 template<typename T> void* ToluaToPODVector(lua_State* L, int narg, void* def);
-/// Convert Lua table to PODVector<unsigned>.
+/// Convert PODVector<unsigned>.
 template<> void* ToluaToPODVector<unsigned>(lua_State* L, int narg, void* def);
 
 /// Push PODVector<T> to Lua as a table.
@@ -112,7 +112,6 @@ template<> int ToluaPushPODVector<unsigned>(lua_State* L, void* data, const char
 template<> int ToluaPushPODVector<SoundSource*>(lua_State* L, void* data, const char* type);
 /// Push PODVector<UIElement*> to Lua as a table.
 template<> int ToluaPushPODVector<UIElement*>(lua_State* L, void* data, const char* type);
-
 /// Push PODVector<Vector3> to Lua as a table.
 template<> int ToluaPushPODVector<Vector3>(lua_State* L, void* data, const char* type);
 /// Push PODVector<IntVector2> to Lua as a table.
@@ -122,6 +121,4 @@ template<> int ToluaPushPODVector<OctreeQueryResult>(lua_State* L, void* data, c
 /// Push PODVector<PhysicsRaycastResult> to Lua as a table.
 template<> int ToluaPushPODVector<PhysicsRaycastResult>(lua_State* L, void* data, const char* type);
 /// Push PODVector<RayQueryResult> to Lua as a table.
-template<> int ToluaPushPODVector<RayQueryResult>(lua_State* L, void* data, const char* type);
-
-
+template<> int ToluaPushPODVector<RayQueryResult>(lua_State* L, void* data, const char* type);