Fix few doc types

This commit is contained in:
Rochet2
2015-05-11 15:58:37 +03:00
parent f3cd70c401
commit 5c68b7301a
8 changed files with 19 additions and 19 deletions

View File

@@ -26,7 +26,7 @@ namespace LuaBattleGround
/** /**
* Returns the amount of alive players in the [BattleGround] by the team ID. * Returns the amount of alive players in the [BattleGround] by the team ID.
* *
* @param uint32 team : team ID * @param [Team] team : team ID
* @return uint32 count * @return uint32 count
*/ */
int GetAlivePlayersCountByTeam(Eluna* /*E*/, lua_State* L, BattleGround* bg) int GetAlivePlayersCountByTeam(Eluna* /*E*/, lua_State* L, BattleGround* bg)
@@ -91,7 +91,7 @@ namespace LuaBattleGround
/** /**
* Returns the amount of free slots for the selected team in the specific [BattleGround]. * Returns the amount of free slots for the selected team in the specific [BattleGround].
* *
* @param uint32 team : team ID * @param [Team] team : team ID
* @return uint32 freeSlots * @return uint32 freeSlots
*/ */
int GetFreeSlotsForTeam(Eluna* /*E*/, lua_State* L, BattleGround* bg) int GetFreeSlotsForTeam(Eluna* /*E*/, lua_State* L, BattleGround* bg)

View File

@@ -1862,7 +1862,7 @@ namespace LuaGlobalFunctions
/** /**
* Creates a [WorldPacket]. * Creates a [WorldPacket].
* *
* @param uint32 opcode : the opcode of the packet * @param [Opcodes] opcode : the opcode of the packet
* @param uint32 size : the size of the packet * @param uint32 size : the size of the packet
* @return [WorldPacket] packet * @return [WorldPacket] packet
*/ */
@@ -1982,7 +1982,7 @@ namespace LuaGlobalFunctions
* BAN_IP * BAN_IP
* }; * };
* *
* @param int32 banMode : method of ban, refer to BanMode above * @param [BanMode] banMode : method of ban, refer to BanMode above
* @param string nameOrIP : name of the [Player] or IP of the [Player] * @param string nameOrIP : name of the [Player] or IP of the [Player]
* @param uint32 duration : duration (in seconds) of the ban * @param uint32 duration : duration (in seconds) of the ban
* @param string reason = "" : ban reason, this is optional * @param string reason = "" : ban reason, this is optional
@@ -2053,7 +2053,7 @@ namespace LuaGlobalFunctions
* @param string text : contents of the mail * @param string text : contents of the mail
* @param uint32 receiverGUIDLow : low GUID of the receiver * @param uint32 receiverGUIDLow : low GUID of the receiver
* @param uint32 senderGUIDLow = 0 : low GUID of the sender * @param uint32 senderGUIDLow = 0 : low GUID of the sender
* @param uint32 stationary = MAIL_STATIONERY_DEFAULT : type of mail that is being sent as, refer to MailStationery above * @param [MailStationery] stationary = MAIL_STATIONERY_DEFAULT : type of mail that is being sent as, refer to MailStationery above
* @param uint32 delay = 0 : mail send delay in milliseconds * @param uint32 delay = 0 : mail send delay in milliseconds
* @param uint32 money = 0 : money to send * @param uint32 money = 0 : money to send
* @param uint32 cod = 0 : cod money amount * @param uint32 cod = 0 : cod money amount

View File

@@ -387,7 +387,7 @@ namespace LuaItem
/** /**
* Returns the [Item]s enchantment ID by enchant slot specified * Returns the [Item]s enchantment ID by enchant slot specified
* *
* @param uint32 enchantSlot : the enchant slot specified * @param [EnchantmentSlot] enchantSlot : the enchant slot specified
* @return uint32 enchantId : the id of the enchant slot specified * @return uint32 enchantId : the id of the enchant slot specified
*/ */
int GetEnchantmentId(Eluna* /*E*/, lua_State* L, Item* item) int GetEnchantmentId(Eluna* /*E*/, lua_State* L, Item* item)

View File

@@ -1340,9 +1340,9 @@ namespace LuaPlayer
} }
/** /**
* Returns the [Player]s current team ID * Returns the [Player]s [TeamId]
* *
* @return [PvpTeamIndex] teamId * @return [TeamId] teamId
*/ */
int GetTeam(Eluna* /*E*/, lua_State* L, Player* player) int GetTeam(Eluna* /*E*/, lua_State* L, Player* player)
{ {
@@ -1773,7 +1773,7 @@ namespace LuaPlayer
* - GENDER_MALE = 0 * - GENDER_MALE = 0
* - GENDER_FEMALE = 1 * - GENDER_FEMALE = 1
* *
* @param uint32 gender * @param [Gender] gender
*/ */
int SetGender(Eluna* /*E*/, lua_State* L, Player* player) int SetGender(Eluna* /*E*/, lua_State* L, Player* player)
{ {
@@ -3282,7 +3282,7 @@ namespace LuaPlayer
} }
/** /**
* Learn the [Player] the [Talent] specified by talent_id and talentRank * Learn the [Player] the talent specified by talent_id and talentRank
* *
* @param uint32 talent_id * @param uint32 talent_id
* @param uint32 talentRank * @param uint32 talentRank

View File

@@ -43,7 +43,7 @@ namespace LuaQuest
* }; * };
* </pre> * </pre>
* *
* @param uint32 flag : all available flags can be seen above * @param [QuestFlags] flag : all available flags can be seen above
* @return bool hasFlag * @return bool hasFlag
*/ */
int HasFlag(Eluna* /*E*/, lua_State* L, Quest* quest) int HasFlag(Eluna* /*E*/, lua_State* L, Quest* quest)
@@ -150,7 +150,7 @@ namespace LuaQuest
/** /**
* Returns the [Quest]'s flags. * Returns the [Quest]'s flags.
* *
* @return uint32 flags * @return [QuestFlags] flags
*/ */
int GetFlags(Eluna* /*E*/, lua_State* L, Quest* quest) int GetFlags(Eluna* /*E*/, lua_State* L, Quest* quest)
{ {

View File

@@ -540,7 +540,7 @@ namespace LuaUnit
/** /**
* Returns true if the [Unit] has the given unit state. * Returns true if the [Unit] has the given unit state.
* *
* @param uint32 state : an unit state * @param [UnitState] state : an unit state
* @return bool hasState * @return bool hasState
*/ */
int HasUnitState(Eluna* /*E*/, lua_State* L, Unit* unit) int HasUnitState(Eluna* /*E*/, lua_State* L, Unit* unit)
@@ -996,7 +996,7 @@ namespace LuaUnit
/** /**
* Returns the [Unit]'s race ID. * Returns the [Unit]'s race ID.
* *
* @return uint8 race * @return [Races] race
*/ */
int GetRace(Eluna* /*E*/, lua_State* L, Unit* unit) int GetRace(Eluna* /*E*/, lua_State* L, Unit* unit)
{ {
@@ -1007,7 +1007,7 @@ namespace LuaUnit
/** /**
* Returns the [Unit]'s class ID. * Returns the [Unit]'s class ID.
* *
* @return uint8 class * @return [Classes] class
*/ */
int GetClass(Eluna* /*E*/, lua_State* L, Unit* unit) int GetClass(Eluna* /*E*/, lua_State* L, Unit* unit)
{ {
@@ -2282,7 +2282,7 @@ namespace LuaUnit
/** /**
* Adds the given unit state for the [Unit]. * Adds the given unit state for the [Unit].
* *
* @param uint32 state * @param [UnitState] state
*/ */
int AddUnitState(Eluna* /*E*/, lua_State* L, Unit* unit) int AddUnitState(Eluna* /*E*/, lua_State* L, Unit* unit)
{ {
@@ -2299,7 +2299,7 @@ namespace LuaUnit
/** /**
* Removes the given unit state from the [Unit]. * Removes the given unit state from the [Unit].
* *
* @param uint32 state * @param [UnitState] state
*/ */
int ClearUnitState(Eluna* /*E*/, lua_State* L, Unit* unit) int ClearUnitState(Eluna* /*E*/, lua_State* L, Unit* unit)
{ {

View File

@@ -654,7 +654,7 @@ namespace LuaWorldObject
* @param float y * @param float y
* @param float z * @param float z
* @param float o * @param float o
* @param [TempSummonType] spawnType = 8 : defines how and when the creature despawns * @param [TempSummonType] spawnType = MANUAL_DESPAWN : defines how and when the creature despawns
* @param uint32 despawnTimer = 0 : despawn time in milliseconds * @param uint32 despawnTimer = 0 : despawn time in milliseconds
* @return [Creature] spawnedCreature * @return [Creature] spawnedCreature
*/ */

View File

@@ -43,7 +43,7 @@ namespace LuaPacket
/** /**
* Sets the opcode of the [WorldPacket] to the specified opcode. * Sets the opcode of the [WorldPacket] to the specified opcode.
* *
* @param uint32 opcode : see Opcodes.h for all known opcodes * @param [Opcodes] opcode : see Opcodes.h for all known opcodes
*/ */
int SetOpcode(Eluna* /*E*/, lua_State* L, WorldPacket* packet) int SetOpcode(Eluna* /*E*/, lua_State* L, WorldPacket* packet)
{ {