Doxyfy s_user.h and s_user.c.

[ircu2.10.12-pk.git] / include / s_user.h

diff --git a/include/s_user.h b/include/s_user.h
index aebbbcd47559b3ae7bf8db421c01091e1ce650d7..350e3459aa961e0ff83bdc5320395c0311fc1f9b 100644 (file)
--- a/include/s_user.h
+++ b/include/s_user.h
@@ -20,14 +20,14 @@ struct Flags;
  * Macros
  */
 
-/*
- * Nick flood limit
+/**
+ * Nick flood limit.
  * Minimum time between nick changes.
  * (The first two changes are allowed quickly after another however).
  */
 #define NICK_DELAY 30
 
-/*
+/**
  * Target flood time.
  * Minimum time between target changes.
  * (MAXTARGETS are allowed simultaneously however).
@@ -37,24 +37,29 @@ struct Flags;
 
 /* return values for hunt_server() */
 
-#define HUNTED_NOSUCH   (-1)    /* if the hunted server is not found */
-#define HUNTED_ISME     0       /* if this server should execute the command */
-#define HUNTED_PASS     1       /* if message passed onwards successfully */
+#define HUNTED_NOSUCH   (-1)    /**< if the hunted server is not found */
+#define HUNTED_ISME     0       /**< if this server should execute the command */
+#define HUNTED_PASS     1       /**< if message passed onwards successfully */
 
 /* send sets for send_umode() */
-#define ALL_UMODES 0  /* both local and global user modes */
-#define SEND_UMODES 1  /* global user modes only */
-#define SEND_UMODES_BUT_OPER 2  /* global user modes except for FLAG_OPER */
+#define ALL_UMODES 0  /**< both local and global user modes */
+#define SEND_UMODES 1  /**< global user modes only */
+#define SEND_UMODES_BUT_OPER 2  /**< global user modes except for FLAG_OPER */
 
 /* used when sending to #mask or $mask */
 
-#define MATCH_SERVER  1
-#define MATCH_HOST    2
+#define MATCH_SERVER  1 /**< flag for relay_masked_message (etc) to indicate the mask matches a server name */
+#define MATCH_HOST    2 /**< flag for relay_masked_message (etc) to indicate the mask matches host name */
 
-#define COOKIE_VERIFIED 0xffffffff
+#define COOKIE_VERIFIED 0xffffffff /**< value for cli_cookie() to show completion */
 
-extern struct SLink *opsarray[];
+extern struct SLink *opsarray[]; /**< element N is a list of local opers with bit N set in their server notice mask (cli_snomask()) */
 
+/** Formatter function for send_user_info().
+ * @param who Client being displayed.
+ * @param sptr Client requesting information.
+ * @param buf Message buffer that should receive the response text.
+ */
 typedef void (*InfoFormatter)(struct Client* who, struct Client *sptr, struct MsgBuf* buf);
 
 /*
@@ -105,10 +110,10 @@ extern unsigned int umode_make_snomask(unsigned int oldmask, char *arg,
                                        int what);
 extern int send_supported(struct Client *cptr);
 
-#define NAMES_ALL 1 /* List all users in channel */
-#define NAMES_VIS 2 /* List only visible users in non-secret channels */
-#define NAMES_EON 4 /* Add an 'End Of Names' reply to the end */
-#define NAMES_DEL 8 /* Show delayed joined users only */
+#define NAMES_ALL 1 /**< List all users in channel */
+#define NAMES_VIS 2 /**< List only visible users in non-secret channels */
+#define NAMES_EON 4 /**< Add an 'End Of Names' reply to the end */
+#define NAMES_DEL 8 /**< Show delayed joined users only */
 
 void do_names(struct Client* sptr, struct Channel* chptr, int filter);