Skip to content

Commit bf579dd

Browse files
committed
Update last remaining method documentation to use tables
1 parent a80dcf1 commit bf579dd

File tree

4 files changed

+40
-45
lines changed

4 files changed

+40
-45
lines changed

methods/TrinityCore/CorpseMethods.h

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,11 @@ namespace LuaCorpse
3939
/**
4040
* Returns the [CorpseType] of a [Corpse].
4141
*
42-
* enum CorpseType
43-
* {
44-
* CORPSE_BONES = 0,
45-
* CORPSE_RESURRECTABLE_PVE = 1,
46-
* CORPSE_RESURRECTABLE_PVP = 2
47-
* };
42+
* @table
43+
* @columns [CorpseType, ID]
44+
* @values [CORPSE_BONES, 0]
45+
* @values [CORPSE_RESURRECTABLE_PVE, 1]
46+
* @values [CORPSE_RESURRECTABLE_PVP, 2]
4847
*
4948
* @return [CorpseType] corpseType
5049
*/

methods/TrinityCore/MapMethods.h

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -225,15 +225,14 @@ namespace LuaMap
225225
/**
226226
* Sets the [Weather] type based on [WeatherType] and grade supplied.
227227
*
228-
* enum WeatherType
229-
* {
230-
* WEATHER_TYPE_FINE = 0,
231-
* WEATHER_TYPE_RAIN = 1,
232-
* WEATHER_TYPE_SNOW = 2,
233-
* WEATHER_TYPE_STORM = 3,
234-
* WEATHER_TYPE_THUNDERS = 86,
235-
* WEATHER_TYPE_BLACKRAIN = 90
236-
* };
228+
* @table
229+
* @columns [WeatherType, ID]
230+
* @values [WEATHER_TYPE_FINE, 0]
231+
* @values [WEATHER_TYPE_RAIN, 1]
232+
* @values [WEATHER_TYPE_SNOW, 2]
233+
* @values [WEATHER_TYPE_STORM, 3]
234+
* @values [WEATHER_TYPE_THUNDERS, 86]
235+
* @values [WEATHER_TYPE_BLACKRAIN, 90]
237236
*
238237
* @param uint32 zone : id of the zone to set the weather for
239238
* @param [WeatherType] type : the [WeatherType], see above available weather types
@@ -291,12 +290,11 @@ namespace LuaMap
291290
/**
292291
* Returns a table with all the current [Player]s in the map
293292
*
294-
* enum TeamId
295-
* {
296-
* TEAM_ALLIANCE = 0,
297-
* TEAM_HORDE = 1,
298-
* TEAM_NEUTRAL = 2
299-
* };
293+
* @table
294+
* @columns [Team, ID]
295+
* @values [ALLIANCE, 0]
296+
* @values [HORDE, 1]
297+
* @values [NEUTRAL, 2]
300298
*
301299
* @param [TeamId] team : optional check team of the [Player], Alliance, Horde or Neutral (All)
302300
* @return table mapPlayers

methods/TrinityCore/ObjectMethods.h

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -189,17 +189,16 @@ namespace LuaObject
189189
/**
190190
* Returns the TypeId of the [Object].
191191
*
192-
* enum TypeID
193-
* {
194-
* TYPEID_OBJECT = 0,
195-
* TYPEID_ITEM = 1,
196-
* TYPEID_CONTAINER = 2,
197-
* TYPEID_UNIT = 3,
198-
* TYPEID_PLAYER = 4,
199-
* TYPEID_GAMEOBJECT = 5,
200-
* TYPEID_DYNAMICOBJECT = 6,
201-
* TYPEID_CORPSE = 7
202-
* };
192+
* @table
193+
* @columns [TypeID, ID]
194+
* @values [TYPEID_OBJECT, 0]
195+
* @values [TYPEID_ITEM, 1]
196+
* @values [TYPEID_CONTAINER, 2]
197+
* @values [TYPEID_UNIT, 3]
198+
* @values [TYPEID_PLAYER, 4]
199+
* @values [TYPEID_GAMEOBJECT, 5]
200+
* @values [TYPEID_DYNAMICOBJECT, 6]
201+
* @values [TYPEID_CORPSE, 7]
203202
*
204203
* @return uint8 typeID
205204
*/

methods/TrinityCore/WorldObjectMethods.h

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -648,19 +648,18 @@ namespace LuaWorldObject
648648
/**
649649
* Spawns the creature at specified location.
650650
*
651-
* enum TempSummonType
652-
* {
653-
* TEMPSUMMON_TIMED_OR_DEAD_DESPAWN = 1, // despawns after a specified time OR when the creature disappears
654-
* TEMPSUMMON_TIMED_OR_CORPSE_DESPAWN = 2, // despawns after a specified time OR when the creature dies
655-
* TEMPSUMMON_TIMED_DESPAWN = 3, // despawns after a specified time
656-
* TEMPSUMMON_TIMED_DESPAWN_OUT_OF_COMBAT = 4, // despawns after a specified time after the creature is out of combat
657-
* TEMPSUMMON_CORPSE_DESPAWN = 5, // despawns instantly after death
658-
* TEMPSUMMON_CORPSE_TIMED_DESPAWN = 6, // despawns after a specified time after death
659-
* TEMPSUMMON_DEAD_DESPAWN = 7, // despawns when the creature disappears
660-
* TEMPSUMMON_MANUAL_DESPAWN = 8, // despawns when UnSummon() is called
661-
* TEMPSUMMON_TIMED_OOC_OR_CORPSE_DESPAWN = 9, // despawns after a specified time (OOC) OR when the creature dies
662-
* TEMPSUMMON_TIMED_OOC_OR_DEAD_DESPAWN = 10 // despawns after a specified time (OOC) OR when the creature disappears
663-
* };
651+
* @table
652+
* @columns [TempSummonType, ID, Comment]
653+
* @values [TEMPSUMMON_TIMED_OR_DEAD_DESPAWN, 1, "despawns after a specified time OR when the creature disappears"]
654+
* @values [TEMPSUMMON_TIMED_OR_CORPSE_DESPAWN, 2, "despawns after a specified time OR when the creature dies"]
655+
* @values [TEMPSUMMON_TIMED_DESPAWN, 3, "despawns after a specified time"]
656+
* @values [TEMPSUMMON_TIMED_DESPAWN_OUT_OF_COMBAT, 4, "despawns after a specified time after the creature is out of combat"]
657+
* @values [TEMPSUMMON_CORPSE_DESPAWN, 5, "despawns instantly after death"]
658+
* @values [TEMPSUMMON_CORPSE_TIMED_DESPAWN, 6, "despawns after a specified time after death"]
659+
* @values [TEMPSUMMON_DEAD_DESPAWN, 7, "despawns when the creature disappears"]
660+
* @values [TEMPSUMMON_MANUAL_DESPAWN, 8, "despawns when UnSummon() is called"]
661+
* @values [TEMPSUMMON_TIMED_OOC_OR_CORPSE_DESPAWN, 9, "despawns after a specified time (OOC) OR when the creature dies"]
662+
* @values [TEMPSUMMON_TIMED_OOC_OR_DEAD_DESPAWN, 10, "despawns after a specified time (OOC) OR when the creature disappears"]
664663
*
665664
* @param uint32 entry : [Creature]'s entry ID
666665
* @param float x

0 commit comments

Comments
 (0)