From af9bdac9d47dd03307e2dfab6e56547814c4a5ec Mon Sep 17 00:00:00 2001
From: Easelm <easelm@live.com>
Date: Sat, 9 Aug 2014 17:50:58 -0400
Subject: [PATCH] Corpse Method Documentation

Removed corpse documented methods from LuaFunctions.cpp.
---
 CorpseMethods.h  | 36 ++++++++++++++++++++++++++++++++++++
 LuaFunctions.cpp | 12 ++++++------
 2 files changed, 42 insertions(+), 6 deletions(-)

diff --git a/CorpseMethods.h b/CorpseMethods.h
index 615f4b5..db1ff37 100644
--- a/CorpseMethods.h
+++ b/CorpseMethods.h
@@ -9,6 +9,11 @@
 
 namespace LuaCorpse
 {
+    /**
+    * Returns the &Corpse Owner GUID.
+    *
+    * @return uint64 ownerGUID
+    */
     int GetOwnerGUID(lua_State* L, Corpse* corpse)
     {
 #ifndef TRINITY
@@ -19,30 +24,61 @@ namespace LuaCorpse
         return 1;
     }
 
+    /**
+    * Returns the ghost time of a &Corpse.
+    *
+    * @return time_t ghostTime
+    */
     int GetGhostTime(lua_State* L, Corpse* corpse)
     {
         Eluna::Push(L, uint32(corpse->GetGhostTime()));
         return 1;
     }
 
+    /**
+    * Returns the CorpseType of a &Corpse.
+    *
+    * <pre>
+    * enum CorpseType
+    * {
+    *     CORPSE_BONES             = 0,
+    *     CORPSE_RESURRECTABLE_PVE = 1,
+    *     CORPSE_RESURRECTABLE_PVP = 2
+    * };
+    * </pre>
+    *
+    * @return CorpseType corpseType
+    */
     int GetType(lua_State* L, Corpse* corpse)
     {
         Eluna::Push(L, corpse->GetType());
         return 1;
     }
 
+    /**
+    * Resets the &Corpse ghost time.
+    *
+    */
     int ResetGhostTime(lua_State* /*L*/, Corpse* corpse)
     {
         corpse->ResetGhostTime();
         return 0;
     }
 
+    /**
+    * Saves the &Corpse to the database.
+    *
+    */
     int SaveToDB(lua_State* /*L*/, Corpse* corpse)
     {
         corpse->SaveToDB();
         return 0;
     }
 
+    /**
+    * Deletes the &Corpse from the world.
+    *
+    */
     int DeleteBonesFromWorld(lua_State* /*L*/, Corpse* corpse)
     {
         corpse->DeleteBonesFromWorld();
diff --git a/LuaFunctions.cpp b/LuaFunctions.cpp
index fd36979..6eb6803 100644
--- a/LuaFunctions.cpp
+++ b/LuaFunctions.cpp
@@ -1159,12 +1159,12 @@ ElunaRegister<Map> MapMethods[] =
 
 ElunaRegister<Corpse> CorpseMethods[] =
 {
-    { "GetOwnerGUID", &LuaCorpse::GetOwnerGUID },                     // :GetOwnerGUID() - Returns the corpse owner GUID
-    { "GetGhostTime", &LuaCorpse::GetGhostTime },                     // :GetGhostTime() - Returns the ghost time of a corpse
-    { "GetType", &LuaCorpse::GetType },                               // :GetType() - Returns the (CorpseType) of a corpse
-    { "ResetGhostTime", &LuaCorpse::ResetGhostTime },                 // :ResetGhostTime() - Resets the corpse's ghost time
-    { "SaveToDB", &LuaCorpse::SaveToDB },                             // :SaveToDB() - Saves to database
-    { "DeleteBonesFromWorld", &LuaCorpse::DeleteBonesFromWorld },     // :DeleteBonesFromWorld() - Deletes all bones from the world
+    { "GetOwnerGUID", &LuaCorpse::GetOwnerGUID },
+    { "GetGhostTime", &LuaCorpse::GetGhostTime },
+    { "GetType", &LuaCorpse::GetType },
+    { "ResetGhostTime", &LuaCorpse::ResetGhostTime },
+    { "SaveToDB", &LuaCorpse::SaveToDB },
+    { "DeleteBonesFromWorld", &LuaCorpse::DeleteBonesFromWorld },
 
     { NULL, NULL }
 };