Doxyfy whocmds.h and whocmds.c.

[ircu2.10.12-pk.git] / ircd / whocmds.c

diff --git a/ircd/whocmds.c b/ircd/whocmds.c
index bbfa7ad380872c90b9e6155ace0880bacd5d6d17..3c7581f30450cd83d78c899867a47aa12349fca6 100644 (file)
--- a/ircd/whocmds.c
+++ b/ircd/whocmds.c
@@ -19,8 +19,10 @@
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
+ */
+/* @file
+ * @brief Support functions for /WHO-like commands.
+ * @version $Id$
  */
 #include "config.h"
 
@@ -60,8 +62,12 @@
 #include <sys/stat.h>
 #include <unistd.h>
 
-/*
- * The function that actually prints out the WHO reply for a client found
+/** Send a WHO reply to a client who asked.
+ * @param[in] sptr Client who is searching for other users.
+ * @param[in] acptr Client who may be shown to \a sptr.
+ * @param[in] repchan Shared channel that provides visibility.
+ * @param[in] fields Bitmask of WHO_FIELD_* values, indicating what to show.
+ * @param[in] qrt Query type string (ignored unless \a fields & WHO_FIELD_QTY).
  */
 void do_who(struct Client* sptr, struct Client* acptr, struct Channel* repchan,
             int fields, char* qrt)
@@ -245,6 +251,10 @@ void do_who(struct Client* sptr, struct Client* acptr, struct Channel* repchan,
   send_reply(sptr, fields ? RPL_WHOSPCRPL : RPL_WHOREPLY, ++p1);
 }
 
+/** Count number of users who match \a mask.
+ * @param[in] mask user\@host or user\@ip mask to check.
+ * @return Count of matching users.
+ */
 int
 count_users(char *mask)
 {