diff options
author | Sadie Powell <sadie@witchery.services> | 2021-03-31 10:38:54 +0100 |
---|---|---|
committer | Sadie Powell <sadie@witchery.services> | 2021-03-31 10:51:51 +0100 |
commit | 952ee5cc603a5231348b8cfab18ee85a097f5394 (patch) | |
tree | af56b96d229f931ace18fcf69a35614b5921e289 /include/modules | |
parent | 8c3c4f8e8274a598b4ba573f9eabfd0940d2e88d (diff) |
Fix various documentation comments.
Diffstat (limited to 'include/modules')
-rw-r--r-- | include/modules/away.h | 1 | ||||
-rw-r--r-- | include/modules/dns.h | 4 | ||||
-rw-r--r-- | include/modules/httpd.h | 9 | ||||
-rw-r--r-- | include/modules/sql.h | 6 |
4 files changed, 10 insertions, 10 deletions
diff --git a/include/modules/away.h b/include/modules/away.h index e70b598cf..563b599fe 100644 --- a/include/modules/away.h +++ b/include/modules/away.h @@ -51,7 +51,6 @@ class Away::EventListener /** Called when a user wishes to mark themselves as back. * @param user The user who is going away. - * @param message The away message that the user set. * @return Either MOD_RES_ALLOW to allow the user to mark themself as back, MOD_RES_DENY to * disallow the user to mark themself as back, or MOD_RES_PASSTHRU to let another module * handle the event. diff --git a/include/modules/dns.h b/include/modules/dns.h index 141951fd3..5b1c426cd 100644 --- a/include/modules/dns.h +++ b/include/modules/dns.h @@ -182,12 +182,12 @@ namespace DNS } /** Called when this request succeeds - * @param r The query sent back from the nameserver + * @param req The query sent back from the nameserver */ virtual void OnLookupComplete(const Query* req) = 0; /** Called when this request fails or times out. - * @param r The query sent back from the nameserver, check the error code. + * @param req The query sent back from the nameserver, check the error code. */ virtual void OnError(const Query* req) { } diff --git a/include/modules/httpd.h b/include/modules/httpd.h index dca35f099..ccb71595c 100644 --- a/include/modules/httpd.h +++ b/include/modules/httpd.h @@ -186,17 +186,18 @@ class HTTPRequest /** Initialize HTTPRequest. * This constructor is called by m_httpd.so to initialize the class. * @param request_type The request type, e.g. GET, POST, HEAD + * @param parsed_uri The URI which was requested by the client. * @param hdr The headers sent with the request - * @param opaque An opaque pointer used internally by m_httpd, which you must pass back to the module in your reply. + * @param socket The server socket which this request came in via. * @param ip The IP address making the web request. * @param pdata The post data (content after headers) received with the request, up to Content-Length in size */ - HTTPRequest(const std::string& request_type, const HTTPRequestURI& Parseduri, - HTTPHeaders* hdr, HttpServerSocket* socket, const std::string &ip, const std::string &pdata) + HTTPRequest(const std::string& request_type, const HTTPRequestURI& parsed_uri, HTTPHeaders* hdr, + HttpServerSocket* socket, const std::string& ip, const std::string& pdata) : type(request_type) , ipaddr(ip) , postdata(pdata) - , parseduri(Parseduri) + , parseduri(parsed_uri) , headers(hdr) , sock(socket) { diff --git a/include/modules/sql.h b/include/modules/sql.h index 47da6f6bf..292322cda 100644 --- a/include/modules/sql.h +++ b/include/modules/sql.h @@ -129,9 +129,9 @@ class SQL::Result : public classbase /** * Check if there's a column with the specified name in the result * - * @param the column name - * @param on success, this is the column index - * @returns true, or false if the column is not found + * @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. */ virtual bool HasColumn(const std::string& column, size_t& index) = 0; }; |