mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-09 10:39:02 -04:00
Fix a bunch of Doxygen warnings.
This commit is contained in:
parent
6b228abad0
commit
a62ae50007
@ -93,7 +93,7 @@ EXCLUDE =
|
||||
EXCLUDE_SYMLINKS = YES
|
||||
EXCLUDE_PATTERNS = */.git/* \
|
||||
*/doxygen/* \
|
||||
*/commands/* \
|
||||
*/coremods/* \
|
||||
*/modes/* \
|
||||
*/modules/*
|
||||
EXCLUDE_SYMBOLS =
|
||||
@ -219,7 +219,8 @@ EXPAND_ONLY_PREDEF = NO
|
||||
SEARCH_INCLUDES = YES
|
||||
INCLUDE_PATH =
|
||||
INCLUDE_FILE_PATTERNS =
|
||||
PREDEFINED =
|
||||
PREDEFINED = CoreExport=/**/ \
|
||||
INSPIRCD_INTRUSIVE_LIST_NAME=intrusive_list
|
||||
EXPAND_AS_DEFINED =
|
||||
SKIP_FUNCTION_MACROS = YES
|
||||
TAGFILES =
|
||||
|
@ -122,7 +122,7 @@ class ServerLimits
|
||||
*/
|
||||
ServerLimits(ConfigTag* tag);
|
||||
|
||||
/** Maximum length of a n!u@h mask */
|
||||
/** Maximum length of a n!u\@h mask */
|
||||
size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
|
||||
};
|
||||
|
||||
|
@ -528,6 +528,7 @@ class CoreExport InspIRCd
|
||||
/** Return a time_t as a human-readable string.
|
||||
* @param format The format to retrieve the date/time in. See `man 3 strftime`
|
||||
* for more information. If NULL, "%a %b %d %T %Y" is assumed.
|
||||
* @param curtime The timestamp to convert to a human-readable string.
|
||||
* @param utc True to convert the time to string as-is, false to convert it to local time first.
|
||||
* @return A string representing the given date/time.
|
||||
*/
|
||||
|
@ -88,7 +88,6 @@ class CoreExport SocketTimeout : public Timer
|
||||
* @param fd File descriptor of BufferedSocket
|
||||
* @param thesock BufferedSocket to attach to
|
||||
* @param secs_from_now Seconds from now to time out
|
||||
* @param now The current time
|
||||
*/
|
||||
SocketTimeout(int fd, BufferedSocket* thesock, long secs_from_now) : Timer(secs_from_now), sock(thesock), sfd(fd) { }
|
||||
|
||||
|
@ -380,7 +380,7 @@ class CoreExport PrefixMode : public ModeHandler
|
||||
|
||||
/**
|
||||
* Removes this prefix mode from all users on the given channel
|
||||
* @param chan The channel which the server wants to remove your mode from
|
||||
* @param channel The channel which the server wants to remove your mode from
|
||||
* @param changelist Mode change list to populate with the removal of this mode
|
||||
*/
|
||||
void RemoveMode(Channel* channel, Modes::ChangeList& changelist);
|
||||
|
@ -54,9 +54,9 @@ class Modes::ChangeList
|
||||
typedef std::vector<Change> List;
|
||||
|
||||
/** Add a new mode to be changed to this ChangeList
|
||||
* @param handler Mode handler
|
||||
* @param add True if this mode is being set, false if removed
|
||||
* @param parameter Mode parameter
|
||||
* @param mh Mode handler
|
||||
* @param adding True if this mode is being set, false if removed
|
||||
* @param param Mode parameter
|
||||
*/
|
||||
void push(ModeHandler* mh, bool adding, const std::string& param = std::string())
|
||||
{
|
||||
@ -64,8 +64,8 @@ class Modes::ChangeList
|
||||
}
|
||||
|
||||
/** Add a new mode to this ChangeList which will be set on the target
|
||||
* @param handler Mode handler
|
||||
* @param parameter Mode parameter
|
||||
* @param mh Mode handler
|
||||
* @param param Mode parameter
|
||||
*/
|
||||
void push_add(ModeHandler* mh, const std::string& param = std::string())
|
||||
{
|
||||
@ -73,8 +73,8 @@ class Modes::ChangeList
|
||||
}
|
||||
|
||||
/** Add a new mode to this ChangeList which will be unset from the target
|
||||
* @param handler Mode handler
|
||||
* @param parameter Mode parameter
|
||||
* @param mh Mode handler
|
||||
* @param param Mode parameter
|
||||
*/
|
||||
void push_remove(ModeHandler* mh, const std::string& param = std::string())
|
||||
{
|
||||
|
@ -989,7 +989,7 @@ class CoreExport Module : public classbase, public usecountbase
|
||||
* @param user The user that this line of the query is about
|
||||
* @param memb The member shown in this line, NULL if no channel is in this line
|
||||
* @param numeric Numeric to send; modifiable.
|
||||
* @param Return MOD_RES_PASSTHRU to allow the line to be displayed, MOD_RES_DENY to hide it
|
||||
* @return MOD_RES_PASSTHRU to allow the line to be displayed, MOD_RES_DENY to hide it
|
||||
*/
|
||||
virtual ModResult OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, Numeric::Numeric& numeric);
|
||||
|
||||
|
@ -50,7 +50,7 @@ class Snomask
|
||||
|
||||
/** Sends a message to all opers with this snomask.
|
||||
* @param message The message to send
|
||||
* @param remote If true the message will go to the uppercase variant of this snomask
|
||||
* @param letter The snomask character to send the message to.
|
||||
*/
|
||||
void SendMessage(const std::string& message, char letter);
|
||||
|
||||
|
@ -259,9 +259,9 @@ class CoreExport SocketEngine
|
||||
void UpdateWriteCounters(int len_out);
|
||||
|
||||
/** Get data transfer statistics.
|
||||
* @param kbitspersec_in Filled with incoming traffic in this second in kbit/s.
|
||||
* @param kbitspersec_out Filled with outgoing traffic in this second in kbit/s.
|
||||
* @param kbitspersec_total Filled with total traffic in this second in kbit/s.
|
||||
* @param kbitpersec_in Filled with incoming traffic in this second in kbit/s.
|
||||
* @param kbitpersec_out Filled with outgoing traffic in this second in kbit/s.
|
||||
* @param kbitpersec_total Filled with total traffic in this second in kbit/s.
|
||||
*/
|
||||
void CoreExport GetBandwidth(float& kbitpersec_in, float& kbitpersec_out, float& kbitpersec_total) const;
|
||||
|
||||
|
@ -131,7 +131,7 @@ class CoreExport UserManager : public fakederef<UserManager>
|
||||
*/
|
||||
void RemoveCloneCounts(User *user);
|
||||
|
||||
/** Rebuild clone counts. Required when <cidr> settings change.
|
||||
/** Rebuild clone counts. Required when \<cidr> settings change.
|
||||
*/
|
||||
void RehashCloneCounts();
|
||||
|
||||
|
@ -435,7 +435,7 @@ class CoreExport User : public Extensible
|
||||
bool IsModeSet(UserModeReference& moderef) const;
|
||||
|
||||
/** Set a specific usermode to on or off
|
||||
* @param m The user mode
|
||||
* @param mh The user mode
|
||||
* @param value On or off setting of the mode
|
||||
*/
|
||||
void SetMode(ModeHandler* mh, bool value);
|
||||
@ -705,6 +705,7 @@ class CoreExport User : public Extensible
|
||||
|
||||
/** Change a user's nick
|
||||
* @param newnick The new nick. If equal to the users uuid, the nick change always succeeds.
|
||||
* @param newts The time at which this nick change happened.
|
||||
* @return True if the change succeeded
|
||||
*/
|
||||
bool ChangeNick(const std::string& newnick, time_t newts = 0);
|
||||
|
Loading…
x
Reference in New Issue
Block a user