Update last remaining method documentation to use tables

ElunaLuaEngine · Nov 23, 2024 · bf579dd · bf579dd
1 parent a80dcf1
commit bf579dd
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 45 deletions.
diff --git a/methods/TrinityCore/CorpseMethods.h b/methods/TrinityCore/CorpseMethods.h
@@ -39,12 +39,11 @@ namespace LuaCorpse
     /**
      * Returns the [CorpseType] of a [Corpse].
      *
-     *     enum CorpseType
-     *     {
-     *         CORPSE_BONES             = 0,
-     *         CORPSE_RESURRECTABLE_PVE = 1,
-     *         CORPSE_RESURRECTABLE_PVP = 2
-     *     };
+     * @table
+     * @columns [CorpseType, ID]
+     * @values [CORPSE_BONES, 0]
+     * @values [CORPSE_RESURRECTABLE_PVE, 1]
+     * @values [CORPSE_RESURRECTABLE_PVP, 2]
      *
      * @return [CorpseType] corpseType
      */

diff --git a/methods/TrinityCore/MapMethods.h b/methods/TrinityCore/MapMethods.h
@@ -225,15 +225,14 @@ namespace LuaMap
     /**
      * Sets the [Weather] type based on [WeatherType] and grade supplied.
      *
-     *     enum WeatherType
-     *     {
-     *         WEATHER_TYPE_FINE       = 0,
-     *         WEATHER_TYPE_RAIN       = 1,
-     *         WEATHER_TYPE_SNOW       = 2,
-     *         WEATHER_TYPE_STORM      = 3,
-     *         WEATHER_TYPE_THUNDERS   = 86,
-     *         WEATHER_TYPE_BLACKRAIN  = 90
-     *     };
+     * @table
+     * @columns [WeatherType, ID]
+     * @values [WEATHER_TYPE_FINE, 0]
+     * @values [WEATHER_TYPE_RAIN, 1]
+     * @values [WEATHER_TYPE_SNOW, 2]
+     * @values [WEATHER_TYPE_STORM, 3]
+     * @values [WEATHER_TYPE_THUNDERS, 86]
+     * @values [WEATHER_TYPE_BLACKRAIN, 90]
      *
      * @param uint32 zone : id of the zone to set the weather for
      * @param [WeatherType] type : the [WeatherType], see above available weather types
@@ -291,12 +290,11 @@ namespace LuaMap
     /**
     * Returns a table with all the current [Player]s in the map
     *
-    *     enum TeamId
-    *     {
-    *         TEAM_ALLIANCE = 0,
-    *         TEAM_HORDE = 1,
-    *         TEAM_NEUTRAL = 2
-    *     };
+    * @table
+    * @columns [Team, ID]
+    * @values [ALLIANCE, 0]
+    * @values [HORDE, 1]
+    * @values [NEUTRAL, 2]
     *
     * @param [TeamId] team : optional check team of the [Player], Alliance, Horde or Neutral (All)
     * @return table mapPlayers

diff --git a/methods/TrinityCore/ObjectMethods.h b/methods/TrinityCore/ObjectMethods.h
@@ -189,17 +189,16 @@ namespace LuaObject
     /**
      * Returns the TypeId of the [Object].
      *
-     *     enum TypeID
-     *     {
-     *         TYPEID_OBJECT        = 0,
-     *         TYPEID_ITEM          = 1,
-     *         TYPEID_CONTAINER     = 2,
-     *         TYPEID_UNIT          = 3,
-     *         TYPEID_PLAYER        = 4,
-     *         TYPEID_GAMEOBJECT    = 5,
-     *         TYPEID_DYNAMICOBJECT = 6,
-     *         TYPEID_CORPSE        = 7
-     *     };
+     * @table
+     * @columns [TypeID, ID]
+     * @values [TYPEID_OBJECT, 0]
+     * @values [TYPEID_ITEM, 1]
+     * @values [TYPEID_CONTAINER, 2]
+     * @values [TYPEID_UNIT, 3]
+     * @values [TYPEID_PLAYER, 4]
+     * @values [TYPEID_GAMEOBJECT, 5]
+     * @values [TYPEID_DYNAMICOBJECT, 6]
+     * @values [TYPEID_CORPSE, 7]
      *
      * @return uint8 typeID
      */

diff --git a/methods/TrinityCore/WorldObjectMethods.h b/methods/TrinityCore/WorldObjectMethods.h
@@ -648,19 +648,18 @@ namespace LuaWorldObject
     /**
      * Spawns the creature at specified location.
      *
-     *     enum TempSummonType
-     *     {
-     *         TEMPSUMMON_TIMED_OR_DEAD_DESPAWN       = 1, // despawns after a specified time OR when the creature disappears
-     *         TEMPSUMMON_TIMED_OR_CORPSE_DESPAWN     = 2, // despawns after a specified time OR when the creature dies
-     *         TEMPSUMMON_TIMED_DESPAWN               = 3, // despawns after a specified time
-     *         TEMPSUMMON_TIMED_DESPAWN_OUT_OF_COMBAT = 4, // despawns after a specified time after the creature is out of combat
-     *         TEMPSUMMON_CORPSE_DESPAWN              = 5, // despawns instantly after death
-     *         TEMPSUMMON_CORPSE_TIMED_DESPAWN        = 6, // despawns after a specified time after death
-     *         TEMPSUMMON_DEAD_DESPAWN                = 7, // despawns when the creature disappears
-     *         TEMPSUMMON_MANUAL_DESPAWN              = 8, // despawns when UnSummon() is called
-     *         TEMPSUMMON_TIMED_OOC_OR_CORPSE_DESPAWN = 9, // despawns after a specified time (OOC) OR when the creature dies
-     *         TEMPSUMMON_TIMED_OOC_OR_DEAD_DESPAWN   = 10 // despawns after a specified time (OOC) OR when the creature disappears
-     *     };
+     * @table
+     * @columns [TempSummonType, ID, Comment]
+     * @values [TEMPSUMMON_TIMED_OR_DEAD_DESPAWN, 1, "despawns after a specified time OR when the creature disappears"]
+     * @values [TEMPSUMMON_TIMED_OR_CORPSE_DESPAWN, 2, "despawns after a specified time OR when the creature dies"]
+     * @values [TEMPSUMMON_TIMED_DESPAWN, 3, "despawns after a specified time"]
+     * @values [TEMPSUMMON_TIMED_DESPAWN_OUT_OF_COMBAT, 4, "despawns after a specified time after the creature is out of combat"]
+     * @values [TEMPSUMMON_CORPSE_DESPAWN, 5, "despawns instantly after death"]
+     * @values [TEMPSUMMON_CORPSE_TIMED_DESPAWN, 6, "despawns after a specified time after death"]
+     * @values [TEMPSUMMON_DEAD_DESPAWN, 7, "despawns when the creature disappears"]
+     * @values [TEMPSUMMON_MANUAL_DESPAWN, 8, "despawns when UnSummon() is called"]
+     * @values [TEMPSUMMON_TIMED_OOC_OR_CORPSE_DESPAWN, 9, "despawns after a specified time (OOC) OR when the creature dies"]
+     * @values [TEMPSUMMON_TIMED_OOC_OR_DEAD_DESPAWN, 10, "despawns after a specified time (OOC) OR when the creature disappears"]
      *
      * @param uint32 entry : [Creature]'s entry ID
      * @param float x