Core/Misc: Fixed doxygen docs being attached to wrong fields

This commit is contained in:
Shauren
2023-08-27 01:58:50 +02:00
parent 9ca85627e2
commit 43584b4d1d
9 changed files with 43 additions and 43 deletions

View File

@@ -57,8 +57,8 @@ class TC_DATABASE_API MySQLConnection
friend class PingOperation;
public:
MySQLConnection(MySQLConnectionInfo& connInfo); //! Constructor for synchronous connections.
MySQLConnection(ProducerConsumerQueue<SQLOperation*>* queue, MySQLConnectionInfo& connInfo); //! Constructor for asynchronous connections.
MySQLConnection(MySQLConnectionInfo& connInfo); //!< Constructor for synchronous connections.
MySQLConnection(ProducerConsumerQueue<SQLOperation*>* queue, MySQLConnectionInfo& connInfo); //!< Constructor for asynchronous connections.
virtual ~MySQLConnection();
virtual uint32 Open();
@@ -98,18 +98,18 @@ class TC_DATABASE_API MySQLConnection
typedef std::vector<std::unique_ptr<MySQLPreparedStatement>> PreparedStatementContainer;
PreparedStatementContainer m_stmts; //! PreparedStatements storage
bool m_reconnecting; //! Are we reconnecting?
bool m_prepareError; //! Was there any error while preparing statements?
PreparedStatementContainer m_stmts; //!< PreparedStatements storage
bool m_reconnecting; //!< Are we reconnecting?
bool m_prepareError; //!< Was there any error while preparing statements?
private:
bool _HandleMySQLErrno(uint32 errNo, uint8 attempts = 5);
ProducerConsumerQueue<SQLOperation*>* m_queue; //! Queue shared with other asynchronous connections.
std::unique_ptr<DatabaseWorker> m_worker; //! Core worker task.
MySQLHandle* m_Mysql; //! MySQL Handle.
MySQLConnectionInfo& m_connectionInfo; //! Connection info (used for logging)
ConnectionFlags m_connectionFlags; //! Connection flags (for preparing relevant statements)
ProducerConsumerQueue<SQLOperation*>* m_queue; //!< Queue shared with other asynchronous connections.
std::unique_ptr<DatabaseWorker> m_worker; //!< Core worker task.
MySQLHandle* m_Mysql; //!< MySQL Handle.
MySQLConnectionInfo& m_connectionInfo; //!< Connection info (used for logging)
ConnectionFlags m_connectionFlags; //!< Connection flags (for preparing relevant statements)
std::mutex m_Mutex;
MySQLConnection(MySQLConnection const& right) = delete;

View File

@@ -43,7 +43,7 @@ class TC_GAME_API Vehicle : public TransportBase
void Reset(bool evading = false);
void InstallAllAccessories(bool evading);
void ApplyAllImmunities();
void InstallAccessory(uint32 entry, int8 seatId, bool minion, uint8 type, uint32 summonTime); //! May be called from scripts
void InstallAccessory(uint32 entry, int8 seatId, bool minion, uint8 type, uint32 summonTime); // May be called from scripts
Unit* GetBase() const { return _me; }
VehicleEntry const* GetVehicleInfo() const { return _vehicleInfo; }

View File

@@ -130,7 +130,7 @@ class TC_GAME_API GameEventMgr
void UpdateWorldStates(uint16 event_id, bool Activate);
void UpdateEventNPCFlags(uint16 event_id);
void UpdateEventNPCVendor(uint16 event_id, bool activate);
void RunSmartAIScripts(uint16 event_id, bool activate); //! Runs SMART_EVENT_GAME_EVENT_START/_END SAI
void RunSmartAIScripts(uint16 event_id, bool activate); //!< Runs SMART_EVENT_GAME_EVENT_START/_END SAI
bool CheckOneGameEventConditions(uint16 event_id);
void SaveWorldEventStateToDB(uint16 event_id);
bool hasCreatureQuestActiveEventExcept(uint32 quest_id, uint16 event_id);

View File

@@ -4707,8 +4707,8 @@ enum CreatureTypeFlags
CREATURE_TYPE_FLAG_INTERACT_ONLY_WITH_CREATOR = 0x00800000,
CREATURE_TYPE_FLAG_DO_NOT_PLAY_UNIT_EVENT_SOUNDS = 0x01000000,
CREATURE_TYPE_FLAG_HAS_NO_SHADOW_BLOB = 0x02000000,
CREATURE_TYPE_FLAG_TREAT_AS_RAID_UNIT = 0x04000000, //! Creature can be targeted by spells that require target to be in caster's party/raid
CREATURE_TYPE_FLAG_FORCE_GOSSIP = 0x08000000, // Allows the creature to display a single gossip option.
CREATURE_TYPE_FLAG_TREAT_AS_RAID_UNIT = 0x04000000, //!< Creature can be targeted by spells that require target to be in caster's party/raid
CREATURE_TYPE_FLAG_FORCE_GOSSIP = 0x08000000, // Allows the creature to display a single gossip option.
CREATURE_TYPE_FLAG_DO_NOT_SHEATHE = 0x10000000,
CREATURE_TYPE_FLAG_DO_NOT_TARGET_ON_INTERACTION = 0x20000000,
CREATURE_TYPE_FLAG_DO_NOT_RENDER_OBJECT_NAME = 0x40000000,

View File

@@ -277,9 +277,9 @@ void FlightPathMovementGenerator::InitEndGridInfo()
* Storage to preload flightmaster grid at end of flight. For multi-stop flights, this will
* be reinitialized for each flightmaster at the end of each spline (or stop) in the flight.
*/
uint32 nodeCount = _path.size(); //! Number of nodes in path.
uint32 nodeCount = _path.size(); // Number of nodes in path.
ASSERT(nodeCount, "FlightPathMovementGenerator::InitEndGridInfo() called with empty _path");
_endMapId = _path[nodeCount - 1]->ContinentID; //! MapId of last node
_endMapId = _path[nodeCount - 1]->ContinentID; // MapId of last node
if (nodeCount < 3)
_preloadTargetNode = 0;
else

View File

@@ -59,17 +59,17 @@ class FlightPathMovementGenerator : public MovementGeneratorMedium<Player, Fligh
std::string GetDebugInfo() const override;
private:
float _endGridX; //! X coord of last node location
float _endGridY; //! Y coord of last node location
uint32 _endMapId; //! map Id of last node location
uint32 _preloadTargetNode; //! node index where preloading starts
float _endGridX; //!< X coord of last node location
float _endGridY; //!< Y coord of last node location
uint32 _endMapId; //!< map Id of last node location
uint32 _preloadTargetNode; //!< node index where preloading starts
struct TaxiNodeChangeInfo
{
uint32 PathIndex;
int64 Cost;
};
std::deque<TaxiNodeChangeInfo> _pointsForPathSwitch; //! node indexes and costs where TaxiPath changes
std::deque<TaxiNodeChangeInfo> _pointsForPathSwitch; //!< node indexes and costs where TaxiPath changes
};
#endif // TRINITY_FLIGHTPATHMOVEMENTGENERATOR_H

View File

@@ -172,7 +172,7 @@ class TC_GAME_API ReputationMgr
uint8 _honoredFactionCount :8;
uint8 _reveredFactionCount :8;
uint8 _exaltedFactionCount :8;
bool _sendFactionIncreased; //! Play visual effect on next SMSG_SET_FACTION_STANDING sent
bool _sendFactionIncreased; //!< Play visual effect on next SMSG_SET_FACTION_STANDING sent
};
#endif

View File

@@ -240,32 +240,32 @@ enum SpellFacingFlags
enum TriggerCastFlags : uint32
{
TRIGGERED_NONE = 0x00000000, //! Not triggered
TRIGGERED_IGNORE_GCD = 0x00000001, //! Will ignore GCD
TRIGGERED_IGNORE_SPELL_AND_CATEGORY_CD = 0x00000002, //! Will ignore Spell and Category cooldowns
TRIGGERED_IGNORE_POWER_AND_REAGENT_COST = 0x00000004, //! Will ignore power and reagent cost
TRIGGERED_IGNORE_CAST_ITEM = 0x00000008, //! Will not take away cast item or update related achievement criteria
TRIGGERED_IGNORE_AURA_SCALING = 0x00000010, //! Will ignore aura scaling
TRIGGERED_IGNORE_CAST_IN_PROGRESS = 0x00000020, //! Will not check if a current cast is in progress
TRIGGERED_NONE = 0x00000000, //!< Not triggered
TRIGGERED_IGNORE_GCD = 0x00000001, //!< Will ignore GCD
TRIGGERED_IGNORE_SPELL_AND_CATEGORY_CD = 0x00000002, //!< Will ignore Spell and Category cooldowns
TRIGGERED_IGNORE_POWER_AND_REAGENT_COST = 0x00000004, //!< Will ignore power and reagent cost
TRIGGERED_IGNORE_CAST_ITEM = 0x00000008, //!< Will not take away cast item or update related achievement criteria
TRIGGERED_IGNORE_AURA_SCALING = 0x00000010, //!< Will ignore aura scaling
TRIGGERED_IGNORE_CAST_IN_PROGRESS = 0x00000020, //!< Will not check if a current cast is in progress
// reuse = 0x00000040,
TRIGGERED_CAST_DIRECTLY = 0x00000080, //! In Spell::prepare, will be cast directly without setting containers for executed spell
TRIGGERED_IGNORE_AURA_INTERRUPT_FLAGS = 0x00000100, //! Will ignore interruptible aura's at cast
TRIGGERED_IGNORE_SET_FACING = 0x00000200, //! Will not adjust facing to target (if any)
TRIGGERED_IGNORE_SHAPESHIFT = 0x00000400, //! Will ignore shapeshift checks
TRIGGERED_CAST_DIRECTLY = 0x00000080, //!< In Spell::prepare, will be cast directly without setting containers for executed spell
TRIGGERED_IGNORE_AURA_INTERRUPT_FLAGS = 0x00000100, //!< Will ignore interruptible aura's at cast
TRIGGERED_IGNORE_SET_FACING = 0x00000200, //!< Will not adjust facing to target (if any)
TRIGGERED_IGNORE_SHAPESHIFT = 0x00000400, //!< Will ignore shapeshift checks
// reuse
TRIGGERED_DISALLOW_PROC_EVENTS = 0x00001000, //! Disallows proc events from triggered spell (default)
TRIGGERED_IGNORE_CASTER_MOUNTED_OR_ON_VEHICLE = 0x00002000, //! Will ignore mounted/on vehicle restrictions
TRIGGERED_DISALLOW_PROC_EVENTS = 0x00001000, //!< Disallows proc events from triggered spell (default)
TRIGGERED_IGNORE_CASTER_MOUNTED_OR_ON_VEHICLE = 0x00002000, //!< Will ignore mounted/on vehicle restrictions
// reuse = 0x00004000,
// reuse = 0x00008000,
TRIGGERED_IGNORE_CASTER_AURAS = 0x00010000, //! Will ignore caster aura restrictions or requirements
TRIGGERED_DONT_RESET_PERIODIC_TIMER = 0x00020000, //! Will allow periodic aura timers to keep ticking (instead of resetting)
TRIGGERED_DONT_REPORT_CAST_ERROR = 0x00040000, //! Will return SPELL_FAILED_DONT_REPORT in CheckCast functions
TRIGGERED_FULL_MASK = 0x0007FFFF, //! Used when doing CastSpell with triggered == true
TRIGGERED_IGNORE_CASTER_AURAS = 0x00010000, //!< Will ignore caster aura restrictions or requirements
TRIGGERED_DONT_RESET_PERIODIC_TIMER = 0x00020000, //!< Will allow periodic aura timers to keep ticking (instead of resetting)
TRIGGERED_DONT_REPORT_CAST_ERROR = 0x00040000, //!< Will return SPELL_FAILED_DONT_REPORT in CheckCast functions
TRIGGERED_FULL_MASK = 0x0007FFFF, //!< Used when doing CastSpell with triggered == true
// debug flags (used with .cast triggered commands)
TRIGGERED_IGNORE_EQUIPPED_ITEM_REQUIREMENT = 0x00080000, //! Will ignore equipped item requirements
TRIGGERED_IGNORE_TARGET_CHECK = 0x00100000, //! Will ignore most target checks (mostly DBC target checks)
TRIGGERED_IGNORE_CASTER_AURASTATE = 0x00200000, //! Will ignore caster aura states including combat requirements and death state
TRIGGERED_IGNORE_EQUIPPED_ITEM_REQUIREMENT = 0x00080000, //!< Will ignore equipped item requirements
TRIGGERED_IGNORE_TARGET_CHECK = 0x00100000, //!< Will ignore most target checks (mostly DBC target checks)
TRIGGERED_IGNORE_CASTER_AURASTATE = 0x00200000, //!< Will ignore caster aura states including combat requirements and death state
TRIGGERED_FULL_DEBUG_MASK = 0xFFFFFFFF
};

View File

@@ -351,7 +351,7 @@ class boss_freya : public CreatureScript
{
me->AddAura(SPELL_DRAINED_OF_POWER, Elder[n]);
Elder[n]->CastSpell(me, SPELL_IRONBRANCH_ESSENCE, true);
Elder[n]->RemoveLootMode(LOOT_MODE_DEFAULT); //! Why?
Elder[n]->RemoveLootMode(LOOT_MODE_DEFAULT); // Why?
Elder[n]->AI()->AttackStart(who);
AddThreat(who, 250.0f, Elder[n]);
++elderCount;