mangos-mirror/server
0
0
Fork 0
mirror of https://github.com/mangosfour/server.git synced 2025-12-15 10:37:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[m] Lots of Doxygen fixes/additions - thanks to lfxGroove

Browse source
This commit is contained in:
billy1arm 2013-06-23 21:43:27 +01:00 • committed by Antz
parent b134615f92
commit c94dbc84c2
960 changed files with 5905 additions and 6171 deletions
Download patch file Download diff file Expand all files Collapse all files

57
src/game/Chat.cpp
View file

@ -1,4 +1,4 @@
/*
/**
* This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
*
* This program is free software; you can redistribute it and/or modify
@ -1069,7 +1069,7 @@ void ChatHandler::CheckIntegrity(ChatCommand* table, ChatCommand* parentCommand)
}
}
/*
/**
* Search (sub)command for command line available for chat handler access level
*
* @param text Command line string that will parsed for (sub)command search
@ -1084,7 +1084,7 @@ ChatCommand const* ChatHandler::FindCommand(char const* text)
return FindCommand(getCommandTable(), textPtr, command) == CHAT_COMMAND_OK ? command : NULL;
}
/*
/**
* Search (sub)command for command line available for chat handler access level with options and fail case additional info
*
* @param table Pointer to command C-style array first level command where will be searched
@ -1114,7 +1114,7 @@ ChatCommand const* ChatHandler::FindCommand(char const* text)
* parentCommand have parent of command in command arg or NULL
* cmdNamePtr store command name that not found as it extracted from command line
*/
ChatCommandSearchResult ChatHandler::FindCommand(ChatCommand* table, char const*& text, ChatCommand*& command, ChatCommand** parentCommand /*= NULL*/, std::string* cmdNamePtr /*= NULL*/, bool allAvailable /*= false*/, bool exactlyName /*= false*/)
ChatCommandSearchResult ChatHandler::FindCommand(ChatCommand* table, char const* &text, ChatCommand*& command, ChatCommand** parentCommand /*= NULL*/, std::string* cmdNamePtr /*= NULL*/, bool allAvailable /*= false*/, bool exactlyName /*= false*/)
{
std::string cmd = "";
@ -1217,7 +1217,7 @@ ChatCommandSearchResult ChatHandler::FindCommand(ChatCommand* table, char const*
return CHAT_COMMAND_UNKNOWN;
}
/*
/**
* Execute (sub)command available for chat handler access level with options in command line string
*
* @param text Command line string that will parsed for (sub)command search and command specific data
@ -1275,7 +1275,7 @@ void ChatHandler::ExecuteCommand(const char* text)
}
}
/*
/**
* Function find appropriate command and update command security level and help text
*
* @param commandTable Table for first level command search
@ -2170,8 +2170,7 @@ void ChatHandler::FillMessageData(WorldPacket* data, WorldSession* session, uint
*data << addonPrefix;
}
else
*data << ObjectGuid(targetGuid);
*data << ObjectGuid(targetGuid);
*data << uint32(messageLength);
*data << message;
if (session != 0 && type != CHAT_MSG_WHISPER_INFORM && type != CHAT_MSG_DND && type != CHAT_MSG_AFK)
@ -2215,7 +2214,7 @@ Creature* ChatHandler::getSelectedCreature()
return m_session->GetPlayer()->GetMap()->GetAnyTypeCreature(m_session->GetPlayer()->GetSelectionGuid());
}
/*
/**
* Function skip all whitespaces in args string
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2230,7 +2229,7 @@ void ChatHandler::SkipWhiteSpaces(char** args)
++(*args);
}
/*
/**
* Function extract to val arg signed integer value or fail
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2260,7 +2259,7 @@ bool ChatHandler::ExtractInt32(char** args, int32& val)
return true;
}
/*
/**
* Function extract to val arg optional signed integer value or use default value. Fail if extracted not signed integer.
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2279,7 +2278,7 @@ bool ChatHandler::ExtractOptInt32(char** args, int32& val, int32 defVal)
return ExtractInt32(args, val);
}
/*
/**
* Function extract to val arg unsigned integer value or fail
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2312,7 +2311,7 @@ bool ChatHandler::ExtractUInt32Base(char** args, uint32& val, uint32 base)
return true;
}
/*
/**
* Function extract to val arg unsigned long value or fail
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2393,7 +2392,7 @@ bool ChatHandler::ExtractOptUInt32(char** args, uint32& val, uint32 defVal)
return ExtractUInt32(args, val);
}
/*
/**
* Function extract to val arg float value or fail
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2422,7 +2421,7 @@ bool ChatHandler::ExtractFloat(char** args, float& val)
return true;
}
/*
/**
* Function extract to val arg optional float value or use default value. Fail if extracted not float.
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2441,7 +2440,7 @@ bool ChatHandler::ExtractOptFloat(char** args, float& val, float defVal)
return ExtractFloat(args, val);
}
/*
/**
* Function extract name-like string (from non-numeric or special symbol until whitespace)
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2519,7 +2518,7 @@ char* ChatHandler::ExtractLiteralArg(char** args, char const* lit /*= NULL*/)
return name;
}
/*
/**
* Function extract quote-like string (any characters guarded by some special character, in our cases ['")
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2531,7 +2530,7 @@ char* ChatHandler::ExtractQuotedArg(char** args, bool asis /*= false*/)
if (!*args || !** args)
return NULL;
if (**args != '\'' &&** args != '"' &&** args != '[')
if (**args != '\'' &&** args != '"' &&** args != '[')
return NULL;
char guard = (*args)[0];
@ -2568,7 +2567,7 @@ char* ChatHandler::ExtractQuotedArg(char** args, bool asis /*= false*/)
return head;
}
/*
/**
* Function extract quote-like string or literal if quote not detected
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2583,7 +2582,7 @@ char* ChatHandler::ExtractQuotedOrLiteralArg(char** args, bool asis /*= false*/)
return arg;
}
/*
/**
* Function extract on/off literals as boolean values
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2606,7 +2605,7 @@ bool ChatHandler::ExtractOnOff(char** args, bool& value)
return true;
}
/*
/**
* Function extract shift-link-like string (any characters guarded by | and |h|r with some additional internal structure check)
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2795,7 +2794,7 @@ char* ChatHandler::ExtractLinkArg(char** args, char const* const* linkTypes /*=
return head;
}
/*
/**
* Function extract name/number/quote/shift-link-like string
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2814,7 +2813,7 @@ char* ChatHandler::ExtractArg(char** args, bool asis /*= false*/)
return arg;
}
/*
/**
* Function extract name/quote/number/shift-link-like string, and return it if args have more non-whitespace data
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -2826,7 +2825,7 @@ char* ChatHandler::ExtractOptNotLastArg(char** args)
char* arg = ExtractArg(args, true);
// have more data
if (*args &&** args)
if (*args &&** args)
return arg;
// optional name not found
@ -2835,7 +2834,7 @@ char* ChatHandler::ExtractOptNotLastArg(char** args)
return NULL;
}
/*
/**
* Function extract data from shift-link "|color|LINKTYPE:RETURN:SOMETHING1|h[name]|h|r if linkType == LINKTYPE
* It also extract literal/quote if not shift-link in args
*
@ -2860,7 +2859,7 @@ char* ChatHandler::ExtractKeyFromLink(char** text, char const* linkType, char**
return ExtractKeyFromLink(text, linkTypes, &foundIdx, something1);
}
/*
/**
* Function extract data from shift-link "|color|LINKTYPE:RETURN:SOMETHING1|h[name]|h|r if LINKTYPE in linkTypes array
* It also extract literal/quote if not shift-link in args
*
@ -2911,7 +2910,7 @@ char* ChatHandler::ExtractKeyFromLink(char** text, char const* const* linkTypes,
return keyPair[0];
}
/*
/**
* Function extract uint32 key from shift-link "|color|LINKTYPE:RETURN|h[name]|h|r if linkType == LINKTYPE
* It also extract direct number if not shift-link in args
*
@ -3359,7 +3358,7 @@ std::string ChatHandler::ExtractPlayerNameFromLink(char** text)
return name;
}
/*
/**
* Function extract at least one from request player data (pointer/guid/name) from args name/shift-link or selected player if no args
*
* @param args variable pointer to non parsed args string, updated at function call to new position (with skipped white spaces)
@ -3374,7 +3373,7 @@ std::string ChatHandler::ExtractPlayerNameFromLink(char** text)
*/
bool ChatHandler::ExtractPlayerTarget(char** args, Player** player /*= NULL*/, ObjectGuid* player_guid /*= NULL*/, std::string* player_name /*= NULL*/)
{
if (*args &&** args)
if (*args &&** args)
{
std::string name = ExtractPlayerNameFromLink(args);
if (name.empty())