summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--docs/Doxyfile5
-rw-r--r--include/configreader.h2
-rw-r--r--include/inspircd.h1
-rw-r--r--include/inspsocket.h1
-rw-r--r--include/mode.h2
-rw-r--r--include/modechange.h14
-rw-r--r--include/modules.h2
-rw-r--r--include/snomasks.h2
-rw-r--r--include/socketengine.h6
-rw-r--r--include/usermanager.h2
-rw-r--r--include/users.h3
11 files changed, 21 insertions, 19 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile
index f4e526bc7..aa5a34ba6 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -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 =
diff --git a/include/configreader.h b/include/configreader.h
index 4d70d8510..cabd74aff 100644
--- a/include/configreader.h
+++ b/include/configreader.h
@@ -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; }
};
diff --git a/include/inspircd.h b/include/inspircd.h
index a1a828994..824a30e8a 100644
--- a/include/inspircd.h
+++ b/include/inspircd.h
@@ -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.
*/
diff --git a/include/inspsocket.h b/include/inspsocket.h
index 95f29ff11..5c9c1059a 100644
--- a/include/inspsocket.h
+++ b/include/inspsocket.h
@@ -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) { }
diff --git a/include/mode.h b/include/mode.h
index 2e9ed22f3..2aa781c28 100644
--- a/include/mode.h
+++ b/include/mode.h
@@ -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);
diff --git a/include/modechange.h b/include/modechange.h
index e20665790..885c22900 100644
--- a/include/modechange.h
+++ b/include/modechange.h
@@ -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())
{
diff --git a/include/modules.h b/include/modules.h
index d9d05a396..14abad31b 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -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);
diff --git a/include/snomasks.h b/include/snomasks.h
index bd08773e9..817371613 100644
--- a/include/snomasks.h
+++ b/include/snomasks.h
@@ -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);
diff --git a/include/socketengine.h b/include/socketengine.h
index b00643952..b74cb065b 100644
--- a/include/socketengine.h
+++ b/include/socketengine.h
@@ -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;
diff --git a/include/usermanager.h b/include/usermanager.h
index 1b1b0b600..531d50773 100644
--- a/include/usermanager.h
+++ b/include/usermanager.h
@@ -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();
diff --git a/include/users.h b/include/users.h
index 4c8df549d..2fbbf31b6 100644
--- a/include/users.h
+++ b/include/users.h
@@ -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);
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-28 03:45:00 +0000