Add inheritance comments

This commit is contained in:
Rochet2
2015-07-08 11:09:20 +03:00
parent 02c7a06410
commit 8fdd75cf4e
18 changed files with 44 additions and 2 deletions

View File

@@ -16,6 +16,8 @@
* *
* [Aura]s on your player are displayed in-game as a series of icons to the left * [Aura]s on your player are displayed in-game as a series of icons to the left
* of the mini-map. * of the mini-map.
*
* Inherits all methods from: none
*/ */
namespace LuaAura namespace LuaAura
{ {

View File

@@ -9,6 +9,8 @@
/*** /***
* Contains the state of a battleground, e.g. Warsong Gulch, Arathi Basin, etc. * Contains the state of a battleground, e.g. Warsong Gulch, Arathi Basin, etc.
*
* Inherits all methods from: none
*/ */
namespace LuaBattleGround namespace LuaBattleGround
{ {

View File

@@ -9,6 +9,8 @@
/*** /***
* The remains of a [Player] that has died. * The remains of a [Player] that has died.
*
* Inherits all methods from: [Object], [WorldObject]
*/ */
namespace LuaCorpse namespace LuaCorpse
{ {

View File

@@ -10,7 +10,7 @@
/*** /***
* Non-[Player] controlled [Unit]s (i.e. NPCs). * Non-[Player] controlled [Unit]s (i.e. NPCs).
* *
* Inherits all [Object], [WorldObject], and [Unit] methods. * Inherits all methods from: [Object], [WorldObject], [Unit]
*/ */
namespace LuaCreature namespace LuaCreature
{ {

View File

@@ -17,6 +17,8 @@
* The result of a database query. * The result of a database query.
* *
* E.g. the return value of [Global:WorldDBQuery]. * E.g. the return value of [Global:WorldDBQuery].
*
* Inherits all methods from: none
*/ */
namespace LuaQuery namespace LuaQuery
{ {

View File

@@ -7,6 +7,9 @@
#ifndef GAMEOBJECTMETHODS_H #ifndef GAMEOBJECTMETHODS_H
#define GAMEOBJECTMETHODS_H #define GAMEOBJECTMETHODS_H
/***
* Inherits all methods from: [Object], [WorldObject]
*/
namespace LuaGameObject namespace LuaGameObject
{ {
/** /**

View File

@@ -7,6 +7,9 @@
#ifndef GROUPMETHODS_H #ifndef GROUPMETHODS_H
#define GROUPMETHODS_H #define GROUPMETHODS_H
/***
* Inherits all methods from: none
*/
namespace LuaGroup namespace LuaGroup
{ {
/** /**

View File

@@ -7,6 +7,9 @@
#ifndef GUILDMETHODS_H #ifndef GUILDMETHODS_H
#define GUILDMETHODS_H #define GUILDMETHODS_H
/***
* Inherits all methods from: none
*/
namespace LuaGuild namespace LuaGuild
{ {
/* GETTERS */ /* GETTERS */

View File

@@ -7,6 +7,9 @@
#ifndef ITEMMETHODS_H #ifndef ITEMMETHODS_H
#define ITEMMETHODS_H #define ITEMMETHODS_H
/***
* Inherits all methods from: [Object]
*/
namespace LuaItem namespace LuaItem
{ {
/* BOOLEAN */ /* BOOLEAN */

View File

@@ -9,6 +9,8 @@
/*** /***
* A game map, e.g. Azeroth, Eastern Kingdoms, the Molten Core, etc. * A game map, e.g. Azeroth, Eastern Kingdoms, the Molten Core, etc.
*
* Inherits all methods from: none
*/ */
namespace LuaMap namespace LuaMap
{ {

View File

@@ -19,6 +19,8 @@
* *
* The GetValue methods in this class (e.g. [Object:GetInt32Value]) provide low-level access to the data block. * The GetValue methods in this class (e.g. [Object:GetInt32Value]) provide low-level access to the data block.
* Other methods, like [Object:HasFlag] and [Object:GetScale], merely wrap the GetValue methods and provide a simpler interface. * Other methods, like [Object:HasFlag] and [Object:GetScale], merely wrap the GetValue methods and provide a simpler interface.
*
* Inherits all methods from: none
*/ */
namespace LuaObject namespace LuaObject
{ {

View File

@@ -7,6 +7,9 @@
#ifndef PLAYERMETHODS_H #ifndef PLAYERMETHODS_H
#define PLAYERMETHODS_H #define PLAYERMETHODS_H
/***
* Inherits all methods from: [Object], [WorldObject], [Unit]
*/
namespace LuaPlayer namespace LuaPlayer
{ {
/* BOOLEAN */ /* BOOLEAN */
@@ -3088,7 +3091,6 @@ namespace LuaPlayer
* @param [Item] item : item to remove * @param [Item] item : item to remove
* @param uint32 entry : entry of the item to remove * @param uint32 entry : entry of the item to remove
* @param uint32 itemCount = 1 : amount of the item to add * @param uint32 itemCount = 1 : amount of the item to add
* @return [Item] item : the item that was added or nil
*/ */
int RemoveItem(Eluna* /*E*/, lua_State* L, Player* player) int RemoveItem(Eluna* /*E*/, lua_State* L, Player* player)
{ {

View File

@@ -7,6 +7,9 @@
#ifndef QUESTMETHODS_H #ifndef QUESTMETHODS_H
#define QUESTMETHODS_H #define QUESTMETHODS_H
/***
* Inherits all methods from: none
*/
namespace LuaQuest namespace LuaQuest
{ {
/** /**

View File

@@ -9,6 +9,8 @@
/*** /***
* An instance of a spell, created when the spell is cast by a [Unit]. * An instance of a spell, created when the spell is cast by a [Unit].
*
* Inherits all methods from: none
*/ */
namespace LuaSpell namespace LuaSpell
{ {

View File

@@ -7,6 +7,9 @@
#ifndef UNITMETHODS_H #ifndef UNITMETHODS_H
#define UNITMETHODS_H #define UNITMETHODS_H
/***
* Inherits all methods from: [Object], [WorldObject]
*/
namespace LuaUnit namespace LuaUnit
{ {
/* BOOLEAN */ /* BOOLEAN */

View File

@@ -9,6 +9,9 @@
#ifndef CLASSIC #ifndef CLASSIC
#ifndef TBC #ifndef TBC
/***
* Inherits all methods from: none
*/
namespace LuaVehicle namespace LuaVehicle
{ {
/* BOOLEAN */ /* BOOLEAN */

View File

@@ -7,6 +7,9 @@
#ifndef WORLDOBJECTMETHODS_H #ifndef WORLDOBJECTMETHODS_H
#define WORLDOBJECTMETHODS_H #define WORLDOBJECTMETHODS_H
/***
* Inherits all methods from: [Object]
*/
namespace LuaWorldObject namespace LuaWorldObject
{ {
/** /**

View File

@@ -15,6 +15,8 @@
* the client has sent a message that its [Player] wants to logout. * the client has sent a message that its [Player] wants to logout.
* *
* The packet can contain further data, the format of which depends on the opcode. * The packet can contain further data, the format of which depends on the opcode.
*
* Inherits all methods from: none
*/ */
namespace LuaPacket namespace LuaPacket
{ {