Cleanup

src/lua/lua_environment.cpp

@@ -203,7 +203,6 @@ void LuaEnvironment::call_global(const char* func, uint8_t argc, ...)
 Vector3* LuaEnvironment::next_vector3(const Vector3& v)
 {
 	CE_ASSERT(_vec3_used < CROWN_MAX_LUA_VECTOR3, "Maximum number of Vector3 reached");
-
 	return &(_vec3_buffer[_vec3_used++] = v);
 }
 
@@ -216,23 +215,25 @@ Quaternion* LuaEnvironment::next_quaternion(const Quaternion& q)
 Matrix4x4* LuaEnvironment::next_matrix4x4(const Matrix4x4& m)
 {
 	CE_ASSERT(_mat4_used < CROWN_MAX_LUA_MATRIX4X4, "Maximum number of Matrix4x4 reached");
-
 	return &(s_mat4_buffer[_mat4_used++] = m);
 }
 
-bool LuaEnvironment::is_vector3(const Vector3* p)
+bool LuaEnvironment::is_vector3(const Vector3* p) const
 {
-	return (p >= &_vec3_buffer[0] && p <= &_vec3_buffer[CROWN_MAX_LUA_VECTOR3 - 1]);
+	return p >= &_vec3_buffer[0]
+		&& p <= &_vec3_buffer[CROWN_MAX_LUA_VECTOR3 - 1];
 }
 
-bool LuaEnvironment::is_quaternion(const Quaternion* p)
+bool LuaEnvironment::is_quaternion(const Quaternion* p) const
 {
-	return (p >= &_quat_buffer[0] && p <= &_quat_buffer[CROWN_MAX_LUA_QUATERNION - 1]);
+	return p >= &_quat_buffer[0]
+		&& p <= &_quat_buffer[CROWN_MAX_LUA_QUATERNION - 1];
 }
 
-bool LuaEnvironment::is_matrix4x4(const Matrix4x4* p)
+bool LuaEnvironment::is_matrix4x4(const Matrix4x4* p) const
 {
-	return (p >= &s_mat4_buffer[0] && p <= &s_mat4_buffer[CROWN_MAX_LUA_MATRIX4X4 - 1]);
+	return p >= &s_mat4_buffer[0]
+		&& p <= &s_mat4_buffer[CROWN_MAX_LUA_MATRIX4X4 - 1];
 }
 
 void LuaEnvironment::clear_temporaries()

src/lua/lua_environment.h

@@ -19,8 +19,9 @@ enum LuaArgumentType
 	ARGUMENT_FLOAT
 };
 
-/// LuaEnvironment is a wrapper of a subset of Lua functions and
-/// provides utilities for extending Lua
+/// Wraps a subset of Lua functions and provides utilities for extending Lua.
+///
+/// @ingroup Lua
 struct LuaEnvironment
 {
 	LuaEnvironment();
@@ -47,12 +48,21 @@ struct LuaEnvironment
 
 	void clear_temporaries();
 
+	/// Returns a new temporary Vector3.
 	Vector3* next_vector3(const Vector3& v);
+	/// Returns a new temporary Quaternion.
 	Quaternion* next_quaternion(const Quaternion& q);
+	/// Returns a new temporary Matrix4x4.
 	Matrix4x4* next_matrix4x4(const Matrix4x4& m);
-	bool is_vector3(const Vector3* p);
-	bool is_quaternion(const Quaternion* p);
-	bool is_matrix4x4(const Matrix4x4* p);
+
+	/// Returns whether @a p is a temporary Vector3.
+	bool is_vector3(const Vector3* p) const;
+
+	/// Returns whether @a p is a temporary Quaternion.
+	bool is_quaternion(const Quaternion* p) const;
+
+	/// Returns whether @a p is a temporary Matrix4x4.
+	bool is_matrix4x4(const Matrix4x4* p) const;
 
 private:
 

src/lua/lua_stack.h

@@ -33,6 +33,9 @@
 namespace crown
 {
 
+/// Wrapper to manipulate Lua stack.
+///
+/// @ingroup Lua
 struct LuaStack
 {
 	LuaStack(lua_State* L)

src/lua/lua_types.h

@@ -7,6 +7,10 @@
 
 namespace crown
 {
-	struct LuaStack;
-	struct LuaEnvironment;
+
+/// @defgroup Lua Lua
+
+struct LuaStack;
+struct LuaEnvironment;
+
 } // namespace crown