chore(Core/Misc): Change all TODO to doxygen comment (#14966)

This commit is contained in:
Kitzunu
2023-02-12 14:05:34 +01:00
committed by GitHub
parent e37e6327f0
commit f039836a2f
84 changed files with 185 additions and 185 deletions

View File

@@ -159,7 +159,7 @@ public:
return true;
}
// TODO - move item to other slot
/// @todo - move item to other slot
static bool HandleItemMoveCommand(ChatHandler* handler, uint8 srcSlot, uint8 dstSlot)
{
if (srcSlot == dstSlot)

View File

@@ -44,7 +44,7 @@
#include "Tokenize.h"
#include "WeatherMgr.h"
// TODO: this import is not necessary for compilation and marked as unused by the IDE
/// @todo: this import is not necessary for compilation and marked as unused by the IDE
// however, for some reasons removing it would cause a damn linking issue
// there is probably some underlying problem with imports which should properly addressed
// see: https://github.com/azerothcore/azerothcore-wotlk/issues/9766

View File

@@ -229,7 +229,7 @@ public:
for (ObjectGuid const& guid : EggList)
{
// Eggs should be destroyed instead
// @todo: after dynamic spawns
/// @todo: after dynamic spawns
if (GameObject* egg = instance->GetGameObject(guid))
{
egg->SetPhaseMask(2, true);

View File

@@ -777,7 +777,7 @@ public:
return true;
case 16:
SendGossipMenuFor(player, 100116, creature->GetGUID());
// todo: we need to play these 3 emote in sequence, we play only the last one right now.
/// @todo: we need to play these 3 emote in sequence, we play only the last one right now.
creature->HandleEmoteCommand(274);
creature->HandleEmoteCommand(1);
creature->HandleEmoteCommand(397);

View File

@@ -28,7 +28,7 @@
#include "SpellScript.h"
#include "TaskScheduler.h"
// TODO: this import is not necessary for compilation and marked as unused by the IDE
// @todo: this import is not necessary for compilation and marked as unused by the IDE
// however, for some reasons removing it would cause a damn linking issue
// there is probably some underlying problem with imports which should properly addressed
// see: https://github.com/azerothcore/azerothcore-wotlk/issues/9766

View File

@@ -251,7 +251,7 @@ public:
{
drake->AI()->Talk(0);
}
[[fallthrough]]; // TODO: Not sure whether the fallthrough was a mistake (forgetting a break) or intended. This should be double-checked.
[[fallthrough]]; /// @todo: Not sure whether the fallthrough was a mistake (forgetting a break) or intended. This should be double-checked.
}
case EVENT_THRALL_REPOSITION:
{

View File

@@ -200,7 +200,7 @@ public:
break;
case EVENT_HADRONOX_MOVE4:
me->CastSpell(me, SPELL_WEB_FRONT_DOORS, true);
[[fallthrough]]; // TODO: Not sure whether the fallthrough was a mistake (forgetting a break) or intended. This should be double-checked.
[[fallthrough]]; /// @todo: Not sure whether the fallthrough was a mistake (forgetting a break) or intended. This should be double-checked.
case EVENT_HADRONOX_MOVE1:
case EVENT_HADRONOX_MOVE2:
case EVENT_HADRONOX_MOVE3:

View File

@@ -346,7 +346,7 @@ class spell_ahn_kahet_swarmer_aura : public SpellScript
}
else if (_targetCount)
{
// TODO: move spell id to enum
/// @todo: move spell id to enum
caster->CastCustomSpell(SPELL_SWARM, SPELLVALUE_AURA_STACK, _targetCount, caster, true);
if (Aura *aur = caster->GetAura(SPELL_SWARM))
{

View File

@@ -131,7 +131,7 @@ struct npc_taldaram_flamesphere : public NullCreatureAI
DoCastSelf(SPELL_FLAME_SPHERE_SPAWN_EFFECT);
DoCastSelf(SPELL_FLAME_SPHERE_VISUAL);
// TODO: replace with DespawnOrUnsummon
/// @todo: replace with DespawnOrUnsummon
uiDespawnTimer = 13000;
}
@@ -490,7 +490,7 @@ private:
}
};
// TODO: Turn into new script type when Gossips have been updated
// @todo: Turn into new script type when Gossips have been updated
class go_prince_taldaram_sphere : public GameObjectScript
{
public:

View File

@@ -1305,7 +1305,7 @@ public:
if (Creature* acolyte = me->SummonCreature((isCalledBySartharion ? NPC_ACOLYTE_OF_SHADRON : NPC_DISCIPLE_OF_SHADRON), me->GetPositionX(), me->GetPositionY(), me->GetPositionZ(), me->GetOrientation()))
{
// TODO: inpect JustSummoned
/// @todo: inpect JustSummoned
summons.Summon(acolyte);
acolyte->SetPhaseMask(16, true);
}

View File

@@ -141,7 +141,7 @@ public:
n2->GetMotionMaster()->MovePoint(1, NecrolytePos2);
n2->SetUInt32Value(UNIT_NPC_EMOTESTATE, EMOTE_STATE_READY1H);
}
// TODO This spell check is invalid
/// @todo This spell check is invalid
// if (SPELL_NECROLYTE_CHANNELING)
// {
n1->RemoveAura(SPELL_NECROLYTE_CHANNELING);
@@ -410,7 +410,7 @@ public:
{
isInvincible = true;
// TODO This spell check is invalid
/// @todo This spell check is invalid
// if (SPELL_NECROLYTE_CHANNELING)
me->CastSpell(me, SPELL_NECROLYTE_CHANNELING, false);
@@ -434,7 +434,7 @@ public:
void EnterCombat(Unit* /*who*/) override
{
// TODO This spell check is invalid
/// @todo This spell check is invalid
// if (SPELL_NECROLYTE_CHANNELING)
me->RemoveAura(SPELL_NECROLYTE_CHANNELING);
events.Reset();

View File

@@ -63,7 +63,7 @@ enum ScriptTexts
SAY_INTRO_ALLIANCE_1 = 0,
SAY_INTRO_ALLIANCE_4 = 1,
SAY_INTRO_ALLIANCE_5 = 2,
SAY_OUTRO_ALLIANCE_1 = 3, // TODO ALLIANCE OUTRO
SAY_OUTRO_ALLIANCE_1 = 3, /// @todo ALLIANCE OUTRO
SAY_OUTRO_ALLIANCE_2 = 4,
SAY_OUTRO_ALLIANCE_3 = 5,
SAY_OUTRO_ALLIANCE_4 = 6,

View File

@@ -20,7 +20,7 @@
#include "OutdoorPvP.h"
// TODO: "sometimes" set to neutral
// @todo: "sometimes" set to neutral
enum OutdoorPvPNASpells
{

View File

@@ -259,5 +259,5 @@ private:
uint32 m_HordeTowersControlled;
};
// todo: flag carrier death/leave/mount/activitychange should give back the gossip options
// @todo: flag carrier death/leave/mount/activitychange should give back the gossip options
#endif

View File

@@ -39,7 +39,7 @@ EndContentData */
#include "SpellInfo.h"
#include "SpellScript.h"
// TODO: this import is not necessary for compilation and marked as unused by the IDE
// @todo: this import is not necessary for compilation and marked as unused by the IDE
// however, for some reasons removing it would cause a damn linking issue
// there is probably some underlying problem with imports which should properly addressed
// see: https://github.com/azerothcore/azerothcore-wotlk/issues/9766

View File

@@ -30,7 +30,7 @@
#include "SpellAuraEffects.h"
#include "SpellScript.h"
// TODO: this import is not necessary for compilation and marked as unused by the IDE
// @todo: this import is not necessary for compilation and marked as unused by the IDE
// however, for some reasons removing it would cause a damn linking issue
// there is probably some underlying problem with imports which should properly addressed
// see: https://github.com/azerothcore/azerothcore-wotlk/issues/9766

View File

@@ -861,7 +861,7 @@ class spell_dk_anti_magic_shell_raid : public AuraScript
void CalculateAmount(AuraEffect const* /*aurEff*/, int32& amount, bool& /*canBeRecalculated*/)
{
// TODO: this should absorb limited amount of damage, but no info on calculation formula
/// @todo: this should absorb limited amount of damage, but no info on calculation formula
amount = -1;
}

View File

@@ -43,7 +43,7 @@
#include "Vehicle.h"
#include <array>
// TODO: this import is not necessary for compilation and marked as unused by the IDE
// @todo: this import is not necessary for compilation and marked as unused by the IDE
// however, for some reasons removing it would cause a damn linking issue
// there is probably some underlying problem with imports which should properly addressed
// see: https://github.com/azerothcore/azerothcore-wotlk/issues/9766

View File

@@ -31,7 +31,7 @@
#include "SpellMgr.h"
#include "SpellScript.h"
// TODO: this import is not necessary for compilation and marked as unused by the IDE
// @todo: this import is not necessary for compilation and marked as unused by the IDE
// however, for some reasons removing it would cause a damn linking issue
// there is probably some underlying problem with imports which should properly addressed
// see: https://github.com/azerothcore/azerothcore-wotlk/issues/9766
@@ -463,7 +463,7 @@ class spell_hun_chimera_shot : public SpellScript
// Amount of one aura tick
basePoint = int32(CalculatePct(unitTarget->GetMaxPower(POWER_MANA), aurEff->GetAmount()));
int32 casterBasePoint = aurEff->GetAmount() * unitTarget->GetMaxPower(POWER_MANA) / 50; // TODO: Caster uses unitTarget?
int32 casterBasePoint = aurEff->GetAmount() * unitTarget->GetMaxPower(POWER_MANA) / 50; /// @todo: Caster uses unitTarget?
if (basePoint > casterBasePoint)
basePoint = casterBasePoint;
ApplyPct(basePoint, TickCount * 60);

View File

@@ -591,7 +591,7 @@ class spell_mage_ice_barrier_aura : public spell_mage_incanters_absorbtion_base_
{
PrepareAuraScript(spell_mage_ice_barrier_aura);
// TODO: Rework
/// @todo: Rework
static int32 CalculateSpellAmount(Unit* caster, int32 amount, SpellInfo const* spellInfo, const AuraEffect* aurEff)
{
// +80.68% from sp bonus
@@ -627,7 +627,7 @@ class spell_mage_ice_barrier : public SpellScript
{
PrepareSpellScript(spell_mage_ice_barrier);
// TODO: Rework
/// @todo: Rework
static int32 CalculateSpellAmount(Unit* caster, int32 amount, SpellInfo const* spellInfo, const AuraEffect* aurEff)
{
// +80.68% from sp bonus

View File

@@ -329,7 +329,7 @@ public:
enum SentryPoint
{
SPELL_TELEPORT_VISUAL = 799, // TODO Find the correct spell
SPELL_TELEPORT_VISUAL = 799, /// @todo Find the correct spell
QUEST_MISSING_DIPLO_PT14 = 1265,
NPC_TERVOSH = 4967
};

View File

@@ -56,7 +56,7 @@ EndContentData */
#include "WaypointMgr.h"
#include "World.h"
// TODO: this import is not necessary for compilation and marked as unused by the IDE
// @todo: this import is not necessary for compilation and marked as unused by the IDE
// however, for some reasons removing it would cause a damn linking issue
// there is probably some underlying problem with imports which should properly addressed
// see: https://github.com/azerothcore/azerothcore-wotlk/issues/9766