aboutsummaryrefslogtreecommitdiffstats
path: root/include/modules
diff options
context:
space:
mode:
authorGravatar Sadie Powell2026-03-08 18:09:59 +0000
committerGravatar Sadie Powell2026-03-08 18:09:59 +0000
commitf013eec2f295f88a0c5fad75785fd77fa4dfc45a (patch)
treec1486059fa1d35a2b7a2b2647657f898c67875c5 /include/modules
parentMerge branch 'insp4' into master. (diff)
Fix various minor Doxygen issues.
Diffstat (limited to 'include/modules')
-rw-r--r--include/modules/cloak.h6
-rw-r--r--include/modules/hash.h4
-rw-r--r--include/modules/ircv3.h1
-rw-r--r--include/modules/sql.h4
4 files changed, 8 insertions, 7 deletions
diff --git a/include/modules/cloak.h b/include/modules/cloak.h
index dfbb827a6..b016a89dd 100644
--- a/include/modules/cloak.h
+++ b/include/modules/cloak.h
@@ -217,8 +217,8 @@ struct Cloak::Info final
/** Default comparator for cloaks. */
auto operator<=>(const Info&) const = default;
- /** Converts a cloak from the username@hostname form to a \p Cloak::Info.
- * @param str The cloak to convert.
+ /** Converts a cloak from the username\@hostname form to a \p Cloak::Info.
+ * @param cloak The cloak to convert.
*/
static Cloak::Info FromString(const std::string& cloak)
{
@@ -228,7 +228,7 @@ struct Cloak::Info final
return Info(cloak.substr(0, sep), cloak.substr(sep + 1));
}
- /** Converts a \p Cloak::Info to the username@hostname form. */
+ /** Converts a \p Cloak::Info to the username\@hostname form. */
std::string ToString() const
{
std::string ret;
diff --git a/include/modules/hash.h b/include/modules/hash.h
index e590ae525..fff5eb602 100644
--- a/include/modules/hash.h
+++ b/include/modules/hash.h
@@ -191,13 +191,13 @@ public:
{
}
- /** @copydoc Hash::HMACContext::Update */
+ /** @copydoc Hash::Context::Update(const unsigned char*, size_t) */
void Update(const unsigned char *data, size_t len) override
{
buffer.append(reinterpret_cast<const char *>(data), len);
}
- /** @copydoc Hash::HMACContext::Finalize */
+ /** @copydoc Hash::Context::Finalize */
std::string Finalize() override
{
if (!provider)
diff --git a/include/modules/ircv3.h b/include/modules/ircv3.h
index b5a18a511..0d10b8b98 100644
--- a/include/modules/ircv3.h
+++ b/include/modules/ircv3.h
@@ -42,6 +42,7 @@ namespace IRCv3
/**
* Sends a standard reply to the specified user if they have the specified cap
* or a notice if they do not.
+ * @param rt Reply type to send.
* @param user The user to send the reply to.
* @param cap The capability that determines the type of message to send.
* @param command The command that the reply relates to.
diff --git a/include/modules/sql.h b/include/modules/sql.h
index 078d5e617..be2cf0005 100644
--- a/include/modules/sql.h
+++ b/include/modules/sql.h
@@ -79,7 +79,7 @@ public:
* query which will not return rows, this will return the number of
* affected rows. In this case you SHOULD NEVER access any of the result
* set rows, as there aren't any!
- * @returns Number of rows in the result set.
+ * @return Number of rows in the result set.
*/
virtual int Rows() = 0;
@@ -99,7 +99,7 @@ public:
*
* @param column The column name.
* @param index The place to store the column index if it exists.
- * @returns If the column exists then true; otherwise, false.
+ * @return If the column exists then true; otherwise, false.
*/
virtual bool HasColumn(const std::string& column, size_t& index) = 0;
};