Update comment blocks

This commit is contained in:
Amos 2022-02-13 15:16:09 +01:00
parent 9c8644e645
commit a5b3b2dea4
8 changed files with 26 additions and 25 deletions

View File

@ -95,7 +95,7 @@ void CRConServer::RunFrame(void)
//-----------------------------------------------------------------------------
// Purpose: send message
// Input : svMessage -
// Input : *svMessage -
//-----------------------------------------------------------------------------
void CRConServer::Send(const std::string& svMessage) const
{
@ -171,8 +171,8 @@ void CRConServer::Recv(void)
//-----------------------------------------------------------------------------
// Purpose: serializes input
// Input : svRspBuf -
// svRspVal -
// Input : *svRspBuf -
// *svRspVal -
// response_t -
// Output : serialized results as string
//-----------------------------------------------------------------------------
@ -206,7 +206,7 @@ std::string CRConServer::Serialize(const std::string& svRspBuf, const std::strin
//-----------------------------------------------------------------------------
// Purpose: de-serializes input
// Input : svBuf -
// Input : *svBuf -
// Output : de-serialized object
//-----------------------------------------------------------------------------
cl_rcon::request CRConServer::Deserialize(const std::string& svBuf) const
@ -219,8 +219,9 @@ cl_rcon::request CRConServer::Deserialize(const std::string& svBuf) const
//-----------------------------------------------------------------------------
// Purpose: authenticate new connections
// Input : *pData -
// TODO : implement logic for key exchange instead so we never network our
// Input : *cl_request -
// *pData -
// Todo : implement logic for key exchange instead so we never network our
// password in plain text over the wire. create a cvar for this so user could
// also opt out and use legacy authentication instead for older RCON clients
//-----------------------------------------------------------------------------

View File

@ -356,7 +356,7 @@ void CConsole::SuggestPanel(void)
}
//-----------------------------------------------------------------------------
// purpose: checks if the console can autocomplete based on input
// Purpose: checks if the console can autocomplete based on input
//-----------------------------------------------------------------------------
bool CConsole::CanAutoComplete(void)
{

View File

@ -198,8 +198,8 @@ bool CNetCon::ShouldQuit(void) const
//-----------------------------------------------------------------------------
// Purpose: connect to specified address and port
// Input : svInAdr -
// svInPort -
// Input : *svInAdr -
// *svInPort -
// Output : true if connection succeeds, false otherwise
//-----------------------------------------------------------------------------
bool CNetCon::Connect(const std::string& svInAdr, const std::string& svInPort)
@ -233,7 +233,7 @@ void CNetCon::Disconnect(void)
//-----------------------------------------------------------------------------
// Purpose: send message
// Input : svMessage -
// Input : *svMessage -
//-----------------------------------------------------------------------------
void CNetCon::Send(const std::string& svMessage) const
{
@ -328,7 +328,7 @@ void CNetCon::ProcessBuffer(const char* pszIn, int nRecvLen) const
//-----------------------------------------------------------------------------
// Purpose: processes received message
// Input : sv_response -
// Input : *sv_response -
//-----------------------------------------------------------------------------
void CNetCon::ProcessMessage(const sv_rcon::response& sv_response) const
{
@ -359,8 +359,8 @@ void CNetCon::ProcessMessage(const sv_rcon::response& sv_response) const
//-----------------------------------------------------------------------------
// Purpose: serializes input
// Input : svReqBuf -
// svReqVal -
// Input : *svReqBuf -
// *svReqVal -
// request_t -
// Output : serialized results as string
//-----------------------------------------------------------------------------
@ -391,10 +391,10 @@ std::string CNetCon::Serialize(const std::string& svReqBuf, const std::string& s
//-----------------------------------------------------------------------------
// Purpose: de-serializes input
// Input : pszBuf -
// Input : *svBuf -
// Output : de-serialized object
//-----------------------------------------------------------------------------
sv_rcon::response CNetCon::Deserialize(std::string svBuf) const
sv_rcon::response CNetCon::Deserialize(const std::string& svBuf) const
{
sv_rcon::response sv_response;
sv_response.ParseFromArray(svBuf.c_str(), static_cast<int>(svBuf.size()));

View File

@ -31,7 +31,7 @@ public:
void ProcessMessage(const sv_rcon::response& sv_response) const;
std::string Serialize(const std::string& svReqBuf, const std::string& svReqVal, cl_rcon::request_t request_t) const;
sv_rcon::response Deserialize(std::string svBuf) const;
sv_rcon::response Deserialize(const std::string& svBuf) const;
private:
CNetAdr2* m_pNetAdr2 = new CNetAdr2("localhost", "37015");

View File

@ -12,7 +12,7 @@
#include "mathlib/bits.h"
//-----------------------------------------------------------------------------
// purpose: construct/allocate
// Purpose: construct/allocate
//-----------------------------------------------------------------------------
ConVar::ConVar(const char* pszName, const char* pszDefaultValue, int nFlags, const char* pszHelpString, bool bMin, float fMin, bool bMax, float fMax, void* pCallback, void* unk)
{
@ -31,7 +31,7 @@ ConVar::ConVar(const char* pszName, const char* pszDefaultValue, int nFlags, con
}
//-----------------------------------------------------------------------------
// purpose: destructor
// Purpose: destructor
//-----------------------------------------------------------------------------
ConVar::~ConVar(void)
{

View File

@ -6,7 +6,7 @@
#include "engine/sys_utils.h"
//-----------------------------------------------------------------------------
// purpose: construct/allocate
// Purpose: construct/allocate
//-----------------------------------------------------------------------------
ConCommand::ConCommand(const char* pszName, const char* pszHelpString, int nFlags, void* pCallback, void* pCommandCompletionCallback)
{

View File

@ -81,7 +81,7 @@ void CCommandLine::AppendParm(const char* pszParm, const char* pszValues)
}
//-----------------------------------------------------------------------------
// purpose: returns the argument after the one specified, or the default if not found
// Purpose: returns the argument after the one specified, or the default if not found
//-----------------------------------------------------------------------------
const char* CCommandLine::ParmValue(const char* psz, const char* pDefaultVal)
{

View File

@ -12,7 +12,7 @@
//-----------------------------------------------------------------------------
// Purpose: constructor (use this when string contains <[IP]:PORT> or 'loopback'/'localhost').
// input : svInAdr -
// Input : svInAdr -
//-----------------------------------------------------------------------------
CNetAdr2::CNetAdr2(std::string svInAdr)
{
@ -43,7 +43,7 @@ CNetAdr2::CNetAdr2(std::string svInAdr)
//-----------------------------------------------------------------------------
// Purpose: constructor (expects string format <IPv4/IPv6> <PORT>).
// input : svInAdr -
// Input : svInAdr -
// svInPort -
//-----------------------------------------------------------------------------
CNetAdr2::CNetAdr2(std::string svInAdr, std::string svInPort)
@ -86,7 +86,7 @@ CNetAdr2::~CNetAdr2(void)
//-----------------------------------------------------------------------------
// Purpose: sets the IP address.
// input : svInAdr -
// Input : svInAdr -
//-----------------------------------------------------------------------------
void CNetAdr2::SetIP(const std::string& svInAdr)
{
@ -95,7 +95,7 @@ void CNetAdr2::SetIP(const std::string& svInAdr)
//-----------------------------------------------------------------------------
// Purpose: sets the port.
// input : svInPort -
// Input : svInPort -
//-----------------------------------------------------------------------------
void CNetAdr2::SetPort(const std::string& svInPort)
{
@ -104,7 +104,7 @@ void CNetAdr2::SetPort(const std::string& svInPort)
//-----------------------------------------------------------------------------
// Purpose: sets the IP address and port.
// input : svInAdr -
// Input : svInAdr -
// svInPort -
//-----------------------------------------------------------------------------
void CNetAdr2::SetIPAndPort(const std::string& svInAdr, const std::string& svInPort)