Document parameters and return value for the OnNamesListItem() hook

1 files changed, 7 insertions, 0 deletions

diff --git a/include/modules.h b/include/modules.h
index 671785410..2a1ceb07a 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -1042,6 +1042,13 @@ class CoreExport Module : public classbase, public usecountbase
 
 	/** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
 	 * For example NAMESX, channel mode +u and +I, and UHNAMES.
+	 * @param issuer The user who is going to receive the NAMES list being built
+	 * @param item The channel member being considered for inclusion
+	 * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
+	 * prefix mode the member has, can be changed
+	 * @param nick The nick to display, initially set to the member's nick, can be changed
+	 * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
+	 * excluded from this NAMES list
 	 */
 	virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);