summaryrefslogtreecommitdiffstats
path: root/src/Bindings
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/Bindings/LuaWindow.h26
-rw-r--r--src/Bindings/ManualBindings.cpp2
-rw-r--r--src/Bindings/Plugin.h2
3 files changed, 14 insertions, 16 deletions
diff --git a/src/Bindings/LuaWindow.h b/src/Bindings/LuaWindow.h
index d4fc58660..60d4f5792 100644
--- a/src/Bindings/LuaWindow.h
+++ b/src/Bindings/LuaWindow.h
@@ -31,8 +31,7 @@ To overcome this, this object overloads the Destroy functions, which doesn't let
delete the window, but rather leaves it dangling, with only Lua having the reference to it.
Additionally, to forbid Lua from deleting this object while it is used by players, the manual bindings for
cPlayer:OpenWindow check if the window is of this class, and if so, make a global Lua reference for this object.
-This reference needs to be unreferenced in the Destroy() function.
-*/
+This reference needs to be unreferenced in the Destroy() function. */
// tolua_begin
class cLuaWindow :
public cWindow
@@ -43,44 +42,43 @@ class cLuaWindow :
typedef cWindow super;
public:
- /// Create a window of the specified type, with a slot grid of a_SlotsX * a_SlotsY size
+ /** Create a window of the specified type, with a slot grid of a_SlotsX * a_SlotsY size */
cLuaWindow(cWindow::WindowType a_WindowType, int a_SlotsX, int a_SlotsY, const AString & a_Title);
virtual ~cLuaWindow();
- /// Returns the internal representation of the contents that are manipulated by Lua
+ /** Returns the internal representation of the contents that are manipulated by Lua */
cItemGrid & GetContents(void) { return m_Contents; }
// tolua_end
/** Sets the plugin reference and the internal Lua object reference index
- used for preventing Lua's GC to collect this class while the window is open
- */
+ used for preventing Lua's GC to collect this class while the window is open. */
void SetLuaRef(cPluginLua * a_Plugin, int a_LuaRef);
- /// Returns true if SetLuaRef() has been called
+ /** Returns true if SetLuaRef() has been called */
bool IsLuaReferenced(void) const;
- /// Sets the callback function (Lua reference) to call when the window is about to close
+ /** Sets the callback function (Lua reference) to call when the window is about to close */
void SetOnClosing(cPluginLua * a_Plugin, int a_FnRef);
- /// Sets the callback function (Lua reference) to call when a slot is changed
+ /** Sets the callback function (Lua reference) to call when a slot is changed */
void SetOnSlotChanged(cPluginLua * a_Plugin, int a_FnRef);
protected:
- /// Contents of the non-inventory part
+ /** Contents of the non-inventory part */
cItemGrid m_Contents;
- /// The plugin that has opened the window and owns the m_LuaRef
+ /** The plugin that has opened the window and owns the m_LuaRef */
cPluginLua * m_Plugin;
- /// The Lua object reference, used for keeping the object alive as long as any player has the window open
+ /** The Lua object reference, used for keeping the object alive as long as any player has the window open */
int m_LuaRef;
- /// The Lua reference for the callback to call when the window is closing for any player
+ /** The Lua reference for the callback to call when the window is closing for any player */
int m_OnClosingFnRef;
- /// The Lua reference for the callback to call when a slot has changed
+ /** The Lua reference for the callback to call when a slot has changed */
int m_OnSlotChangedFnRef;
// cWindow overrides:
diff --git a/src/Bindings/ManualBindings.cpp b/src/Bindings/ManualBindings.cpp
index e4420c39a..4260d33c7 100644
--- a/src/Bindings/ManualBindings.cpp
+++ b/src/Bindings/ManualBindings.cpp
@@ -1945,7 +1945,7 @@ tolua_lerror:
-/// Provides interface between a Lua table of callbacks and the cBlockTracer::cCallbacks
+/** Provides interface between a Lua table of callbacks and the cBlockTracer::cCallbacks */
class cLuaBlockTracerCallbacks :
public cBlockTracer::cCallbacks
{
diff --git a/src/Bindings/Plugin.h b/src/Bindings/Plugin.h
index 48ba6a77c..956e99dd9 100644
--- a/src/Bindings/Plugin.h
+++ b/src/Bindings/Plugin.h
@@ -42,7 +42,7 @@ public:
// Called each tick
virtual void Tick(float a_Dt) = 0;
- /** Calls the specified hook with the params given. Returns the bool that the hook callback returns.*/
+ /** Calls the specified hook with the params given. Returns the bool that the hook callback returns. */
virtual bool OnBlockSpread (cWorld & a_World, int a_BlockX, int a_BlockY, int a_BlockZ, eSpreadSource a_Source) = 0;
virtual bool OnBlockToPickups (cWorld & a_World, cEntity * a_Digger, int a_BlockX, int a_BlockY, int a_BlockZ, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta, cItems & a_Pickups) = 0;
virtual bool OnChat (cPlayer & a_Player, AString & a_Message) = 0;