Committer  : entrope
CVSROOT    : /cvsroot/undernet-ircu
Module     : ircu2.10
Commit time: 2006-07-15 00:09:20 UTC

Modified files:
     ChangeLog include/ircd_snprintf.h ircd/ircd_events.c
     ircd/ircd_log.c ircd/ircd_res.c ircd/m_burst.c ircd/m_lusers.c
     ircd/m_map.c ircd/m_motd.c ircd/m_oper.c ircd/m_rping.c
     ircd/motd.c ircd/msgq.c ircd/os_generic.c ircd/s_auth.c
     ircd/s_bsd.c ircd/s_conf.c ircd/whowas.c

Log message:

Fix all doxygen (version 1.4.6) warnings.

---------------------- diff included ----------------------
Index: ircu2.10/ChangeLog
diff -u ircu2.10/ChangeLog:1.797 ircu2.10/ChangeLog:1.798
--- ircu2.10/ChangeLog:1.797    Fri Jul 14 16:30:59 2006
+++ ircu2.10/ChangeLog  Fri Jul 14 17:09:09 2006
@@ -1,5 +1,54 @@
 2006-07-14  Michael Poole <[EMAIL PROTECTED]>
 
+       * include/ircd_snprintf.h: Escape %, #, < and > with \.
+
+       * ircd/ircd_events.c (sigInfo): Name the struct type.
+       (evInfo): Likewise.
+
+       * ircd/ircd_log.c (facilities): Likewise.
+       (masks): Likewise.
+       (logInfo): Likewise.
+
+       * ircd/ircd_res.c (make_request): Update doxygen parameters list.
+       (gethost_byname): Likewise.
+       (gethost_byaddr): Likewise.
+       (do_query_name): Likewise.
+       (do_query_number): Likewise.
+
+       * ircd/m_burst.c (ms_burst): Escape %, < and > with \.
+
+       * ircd/m_lusers.c (m_lusers): Fix ordering of \li and \a.
+       (ms_lusers): Likewise.
+
+       * ircd/m_map.c (m_map): Delete stray \.
+
+       * ircd/m_motd.c (m_motd): Fix ordering of \li and \a.
+       (ms_motd): Likewise.
+
+       * ircd/m_oper.c (ms_oper): Escape < and > with \.
+
+       * ircd/m_rping.c (mo_rping): Likewise.
+
+       * ircd/motd.c (MotdList): Name the struct type.
+
+       * ircd/msgq.c (MQData): Likewise.
+
+       * ircd/os_generic.c (sockaddr_from_irc): Add doxygen comment for
+       argument 'family'.
+
+       * ircd/s_auth.c (HeaderMessages): Name the struct type.
+
+       * ircd/s_bsd.c (connect_dns_callback): Update doxygen parameters list.
+
+       * ircd/s_conf.c (conf_dns_callback): Likewise.
+       (free_mapping): Move '[in]' before the name of the parameter it
+       modifies.
+
+       * ircd/whowas.c (wwList): Name the struct type.
+       (m_whowas): Escape $, < and > with \.
+
+2006-07-14  Michael Poole <[EMAIL PROTECTED]>
+
        * ircd/m_wallchops.c (m_functions): Delete duplicative comment.
        (m_wallchops): Write doxygen comment.
        (ms_wallchops): Write doxygen comment.
Index: ircu2.10/include/ircd_snprintf.h
diff -u ircu2.10/include/ircd_snprintf.h:1.8 
ircu2.10/include/ircd_snprintf.h:1.9
--- ircu2.10/include/ircd_snprintf.h:1.8        Mon Oct  4 21:21:37 2004
+++ ircu2.10/include/ircd_snprintf.h    Fri Jul 14 17:09:09 2006
@@ -20,7 +20,7 @@
  */
 /** @file
  * @brief IRC-specific printf() clone interface.
- * @version $Id: ircd_snprintf.h,v 1.8 2004/10/05 04:21:37 entrope Exp $
+ * @version $Id: ircd_snprintf.h,v 1.9 2006/07/15 00:09:09 entrope Exp $
  */
 #ifndef INCLUDED_sys_types_h
 #include <sys/types.h>
@@ -33,12 +33,12 @@
 
 struct Client;
 
-/** structure passed as argument for %v conversion */
+/** structure passed as argument for \%v conversion */
 struct VarData {
   size_t       vd_chars;       /**< number of characters inserted */
   size_t       vd_overflow;    /**< number of characters that couldn't be */
   const char   *vd_format;     /**< format string */
-  va_list      vd_args;        /**< arguments for %v */
+  va_list      vd_args;        /**< arguments for \%v */
 };
 
 #ifndef HAVE_VA_COPY
@@ -76,35 +76,35 @@
 ** would be required by ANSI; the first is support for multibyte
 ** character strings, and the second is support for locales, neither
 ** of which have any relevance for ircu, so again omission seemed to
-** be a good policy.  Additionally, %#x always causes '0x' (or '0X')
+** be a good policy.  Additionally, \%\#x always causes '0x' (or '0X')
 ** to be printed, even if the number is zero.
 **
 **   These functions also have some extensions not seen in a
 ** standards-compliant implementation; technically, the ISO 9x
 ** extensions fall into this category, for instance.  The ISO 9x
-** extensions supported are type extensions--%ju, %tu, and %zu, for
-** instance; %qu and %hhu are also supported.  The extensions added
-** for use in ircu are %Tu, which takes a time_t, and the new %C
+** extensions supported are type extensions--\%ju, \%tu, and \%zu, for
+** instance; \%qu and \%hhu are also supported.  The extensions added
+** for use in ircu are \%Tu, which takes a time_t, and the new \%C
 ** conversion, which inserts either a numeric or a nick, dependant on
-** the &lt;dest> parameter.  The GNU %m extension, which inserts the
+** the \<dest\> parameter.  The GNU \%m extension, which inserts the
 ** strerror() string corresponding to the current value of errno, is
-** also supported, as is a special %v extension, which essentially
+** also supported, as is a special \%v extension, which essentially
 ** does a recursive call to ircd_snprintf.
 **
 **   The following description is descended from the Linux manpage for
 ** the printf family of functions.
 **
 **   The format string is composed of zero or more directives:
-** ordinary characters (not %), which are copied unchanged to the
+** ordinary characters (not \%), which are copied unchanged to the
 ** output stream; and conversion specifications, each of which results
 ** in fetching zero or more subsequent arguments.  Each conversion
-** specification is introduced by the character %.  The arguments must
+** specification is introduced by the character \%.  The arguments must
 ** correspond properly (after type promotion) with the conversion
-** specifier.  After the %, the following appear in sequence:
+** specifier.  After the \%, the following appear in sequence:
 **
 ** <ul><li>Zero or more of the following flags:<dl>
 **
-** <dt>#</dt>
+** <dt>\#</dt>
 **      <dd>specifying that the value should be converted to an
 **     "alternate form."  For c, d, i, n, p, s, and u conversions,
 **     this option has no effect.  For o conversions, the precision
@@ -270,7 +270,7 @@
 **
 ** <dt>p</dt>
 **             <dd>The "void *" pointer argument is printed in
-**             hexadecimal (as if by %#x or %#lx).</dd>
+**             hexadecimal (as if by \%\#x or \%\#lx).</dd>
 **
 ** <dt>n</dt>
 **             <dd>The number of characters written so far is stored into
@@ -279,11 +279,11 @@
 **
 ** <dt>m</dt>
 **             <dd>The error message associated with the current value of
-**             errno is printed as if by %s.</dd>
+**             errno is printed as if by \%s.</dd>
 **
 ** <dt>C</dt>
 **             <dd>The client argument identifier is printed under the
-**             control of the &lt;dest> argument; if &lt;dest> is NULL or
+**             control of the \<dest\> argument; if \<dest\> is NULL or
 **             is a user, the client's name (nickname or server name)
 **             is printed; otherwise, the client's network numeric is
 **             printed.</dd>
@@ -301,9 +301,9 @@
 **             could not be added due to buffer overflow or due to a
 **             precision.</dd>
 **
-** <dt>%<dt>
-**             <dd>A `%' is written.  No argument is converted.  The
-**             complete conversion specification is `%%'.</dd>
+** <dt>\%<dt>
+**             <dd>A `\%' is written.  No argument is converted.  The
+**             complete conversion specification is `\%\%'.</dd>
 ** </dl>
 **
 **   In no case does a non-existent or small field width cause
Index: ircu2.10/ircd/ircd_events.c
diff -u ircu2.10/ircd/ircd_events.c:1.10 ircu2.10/ircd/ircd_events.c:1.11
--- ircu2.10/ircd/ircd_events.c:1.10    Tue Mar 22 16:30:56 2005
+++ ircu2.10/ircd/ircd_events.c Fri Jul 14 17:09:09 2006
@@ -18,7 +18,7 @@
  */
 /** @file
  * @brief Implementation of event loop mid-layer.
- * @version $Id: ircd_events.c,v 1.10 2005/03/23 00:30:56 entrope Exp $
+ * @version $Id: ircd_events.c,v 1.11 2006/07/15 00:09:09 entrope Exp $
  */
 #include "config.h"
 
@@ -85,13 +85,13 @@
  * This is used if an engine does not implement signal handling itself
  * (when Engine::eng_signal is NULL).
  */
-static struct {
+static struct sigInfo_s {
   int          fd;     /**< signal routine's fd */
   struct Socket        sock;   /**< and its struct Socket */
 } sigInfo = { -1 };
 
 /** All the thread info */
-static struct {
+static struct evInfo_s {
   struct Generators    gens;           /**< List of all generators */
   struct Event*               events_free;     /**< struct Event free list */
   unsigned int        events_alloc;    /**< count of allocated struct Events */
Index: ircu2.10/ircd/ircd_log.c
diff -u ircu2.10/ircd/ircd_log.c:1.25 ircu2.10/ircd/ircd_log.c:1.26
--- ircu2.10/ircd/ircd_log.c:1.25       Thu Apr  6 20:27:50 2006
+++ ircu2.10/ircd/ircd_log.c    Fri Jul 14 17:09:10 2006
@@ -22,7 +22,7 @@
  */
 /** @file
  * @brief IRC logging implementation.
- * @version $Id: ircd_log.c,v 1.25 2006/04/07 03:27:50 entrope Exp $
+ * @version $Id: ircd_log.c,v 1.26 2006/07/15 00:09:10 entrope Exp $
  */
 #include "config.h"
 
@@ -98,7 +98,7 @@
 #define LOG_NOTFOUND -2 /**< didn't find a facility corresponding to name */
 
 /** Map names to syslog facilities. */
-static struct {
+static struct facilities_s {
   char *name;   /**< Textual name of facility. */
   int facility; /**< Facility value for syslog(). */
 } facilities[] = {
@@ -118,7 +118,7 @@
 #define SNO_NOTFOUND 0xffffffff /**< didn't find a SNO_MASK value for name */
 
 /** Map names to snomask values. */
-static struct {
+static struct masks_s {
   char *name;           /**< Name of server notice bit. */
   unsigned int snomask; /**< Bitmask corresponding to name. */
 } masks[] = {
@@ -178,7 +178,7 @@
 };
 
 /** Modifiable static information. */
-static struct {
+static struct logInfo_s {
   struct LogFile *filelist; /**< list of log files */
   struct LogFile *freelist; /**< list of free'd log files */
   int            facility; /**< default facility */
Index: ircu2.10/ircd/ircd_res.c
diff -u ircu2.10/ircd/ircd_res.c:1.28 ircu2.10/ircd/ircd_res.c:1.29
--- ircu2.10/ircd/ircd_res.c:1.28       Thu Apr  6 20:27:50 2006
+++ ircu2.10/ircd/ircd_res.c    Fri Jul 14 17:09:10 2006
@@ -18,7 +18,7 @@
  */
 /** @file
  * @brief IRC resolver functions.
- * @version $Id: ircd_res.c,v 1.28 2006/04/07 03:27:50 entrope Exp $
+ * @version $Id: ircd_res.c,v 1.29 2006/07/15 00:09:10 entrope Exp $
  */
 
 #include "client.h"
@@ -245,7 +245,8 @@
 }
 
 /** Create a DNS request record for the server.
- * @param[in] query Callback information for caller.
+ * @param[in] callback Callback function to use.
+ * @param[in] ctx Context parameter for \a callback.
  * @return Newly allocated and linked-in reslist.
  */
 static struct reslist *
@@ -416,7 +417,8 @@
 
 /** Try to look up address for a hostname, trying IPv6 (T_AAAA) first.
  * @param[in] name Hostname to look up.
- * @param[in] query Callback information.
+ * @param[in] callback Function to call upon completion.
+ * @param[in] ctx Callback data to pass to \a callback.
  */
 void
 gethost_byname(const char *name, dns_callback_f callback, void *ctx)
@@ -426,7 +428,8 @@
 
 /** Try to look up hostname for an address.
  * @param[in] addr Address to look up.
- * @param[in] query Callback information.
+ * @param[in] callback Function to call upon completion.
+ * @param[in] ctx Callback data to pass to \a callback.
  */
 void
 gethost_byaddr(const struct irc_in_addr *addr, dns_callback_f callback, void 
*ctx)
@@ -435,7 +438,8 @@
 }
 
 /** Send a query to look up the address for a name.
- * @param[in] query Callback information.
+ * @param[in] callback Function to call upon completion.
+ * @param[in] ctx Context data to pass to \a callback.
  * @param[in] name Hostname to look up.
  * @param[in] request DNS lookup structure (may be NULL).
  * @param[in] type Preferred request type.
@@ -467,7 +471,8 @@
 }
 
 /** Send a query to look up the name for an address.
- * @param[in] query Callback information.
+ * @param[in] callback Callback function to call upon completion.
+ * @param[in] ctx Context information to pass to \a callback.
  * @param[in] addr Address to look up.
  * @param[in] request DNS lookup structure (may be NULL).
  */
Index: ircu2.10/ircd/m_burst.c
diff -u ircu2.10/ircd/m_burst.c:1.44 ircu2.10/ircd/m_burst.c:1.45
--- ircu2.10/ircd/m_burst.c:1.44        Wed Jun 28 19:23:14 2006
+++ ircu2.10/ircd/m_burst.c     Fri Jul 14 17:09:10 2006
@@ -20,7 +20,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  *
- * $Id: m_burst.c,v 1.44 2006/06/29 02:23:14 entrope Exp $
+ * $Id: m_burst.c,v 1.45 2006/07/15 00:09:10 entrope Exp $
  */
 
 #include "config.h"
@@ -100,20 +100,20 @@
  * The meaning of the following parv[]'s depend on their first character:
  * If parv[n] starts with a '+':
  * Net burst, additive modes
- *   parv[n] = <mode>
- *   parv[n+1] = <param> (optional)
- *   parv[n+2] = <param> (optional)
+ *   parv[n] = \<mode\>
+ *   parv[n+1] = \<param\> (optional)
+ *   parv[n+2] = \<param\> (optional)
  * If parv[n] starts with a '%', then n will be parc-1:
- *   parv[n] = %<ban> <ban> <ban> ...
+ *   parv[n] = \%\<ban\> \<ban\> \<ban\> ...
  * If parv[n] starts with another character:
- *   parv[n] = <nick>[:<mode>],<nick>[:<mode>],...
- *   where <mode> defines the mode and op-level
+ *   parv[n] = \<nick\>[:\<mode\>],\<nick\>[:\<mode\>],...
+ *   where \<mode\> defines the mode and op-level
  *   for nick and all following nicks until the
- *   next <mode> field.
- *   Digits in the <mode> field have of two meanings:
+ *   next \<mode\> field.
+ *   Digits in the \<mode\> field have of two meanings:
  *   1) if it is the first field in this BURST message
  *      that contains digits, and/or when a 'v' is
- *      present in the <mode>:
+ *      present in the \<mode\>:
  *      The absolute value of the op-level.
  *   2) if there are only digits in this field and
  *      it is not the first field with digits:
@@ -127,7 +127,7 @@
  * Example:
  * "A8 B #test 87654321 +ntkAl key secret 123 
A8AAG,A8AAC:v,A8AAA:0,A8AAF:2,A8AAD,A8AAB:v1,A8AAE:1 :%ban1 ban2"
  *
- * <mode> list example:
+ * \<mode\> list example:
  *
  * "xxx,sss:v,ttt,aaa:123,bbb,ccc:2,ddd,kkk:v2,lll:2,mmm"
  *
@@ -135,7 +135,7 @@
  *
  *  xxx                // first modeless nicks
  *  sss +v     // then opless nicks
- *  ttt +v     // no ":<mode>": everything stays the same
+ *  ttt +v     // no ":\<mode\>": everything stays the same
  *  aaa -123   // first field with digit: absolute value
  *  bbb -123
  *  ccc -125   // only digits, not first field: increment
Index: ircu2.10/ircd/m_lusers.c
diff -u ircu2.10/ircd/m_lusers.c:1.10 ircu2.10/ircd/m_lusers.c:1.11
--- ircu2.10/ircd/m_lusers.c:1.10       Tue Jul  4 12:44:38 2006
+++ ircu2.10/ircd/m_lusers.c    Fri Jul 14 17:09:10 2006
@@ -20,7 +20,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  *
- * $Id: m_lusers.c,v 1.10 2006/07/04 19:44:38 entrope Exp $
+ * $Id: m_lusers.c,v 1.11 2006/07/15 00:09:10 entrope Exp $
  */
 
 #include "config.h"
@@ -44,8 +44,8 @@
 /** Handle a LUSERS message from a local connection.
  *
  * \a parv may either be empty or have the following elements:
- * \a \li parv[1] is ignored
- * \a \li parv[2] is the server to query
+ * \li \a parv[1] is ignored
+ * \li \a parv[2] is the server to query
  *
  * See @ref m_functions for discussion of the arguments.
  * @param[in] cptr Client that sent us the message.
@@ -82,8 +82,8 @@
 /** Handle a LUSERS message from a server connection.
  *
  * \a parv has the following elements:
- * \a \li parv[1] is ignored
- * \a \li parv[2] is the server to query
+ * \li \a parv[1] is ignored
+ * \li \a parv[2] is the server to query
  *
  * See @ref m_functions for discussion of the arguments.
  * @param[in] cptr Client that sent us the message.
Index: ircu2.10/ircd/m_map.c
diff -u ircu2.10/ircd/m_map.c:1.16 ircu2.10/ircd/m_map.c:1.17
--- ircu2.10/ircd/m_map.c:1.16  Tue Jul  4 12:44:38 2006
+++ ircu2.10/ircd/m_map.c       Fri Jul 14 17:09:10 2006
@@ -20,7 +20,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  *
- * $Id: m_map.c,v 1.16 2006/07/04 19:44:38 entrope Exp $
+ * $Id: m_map.c,v 1.17 2006/07/15 00:09:10 entrope Exp $
  */
 
 #include "config.h"
@@ -115,7 +115,7 @@
 /** Handle a MAP request from a local connection.
  * -- by Run
  *
- * \a \parv has the following elements:
+ * \a parv has the following elements:
  * \li \a parv[1] (optional) is a mask of servers to display in the map
  *
  * See @ref m_functions for discussion of the arguments.
Index: ircu2.10/ircd/m_motd.c
diff -u ircu2.10/ircd/m_motd.c:1.15 ircu2.10/ircd/m_motd.c:1.16
--- ircu2.10/ircd/m_motd.c:1.15 Tue Jul  4 12:44:38 2006
+++ ircu2.10/ircd/m_motd.c      Fri Jul 14 17:09:10 2006
@@ -20,7 +20,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  *
- * $Id: m_motd.c,v 1.15 2006/07/04 19:44:38 entrope Exp $
+ * $Id: m_motd.c,v 1.16 2006/07/15 00:09:10 entrope Exp $
  */
 
 #include "config.h"
@@ -47,7 +47,7 @@
 /** Handle a MOTD message from a local connection.
  *
  * \a parv has the following elements:
- * \a \li parv[1] is the server to query
+ * \li \a parv[1] is the server to query
  *
  * modified 30 mar 1995 by flux ([EMAIL PROTECTED])
  * T line patch - display motd based on hostmask
@@ -75,7 +75,7 @@
 /** Handle a MOTD message from a server connection.
  *
  * \a parv has the following elements:
- * \a \li parv[1] is the server to query
+ * \li \a parv[1] is the server to query
  *
  * modified 30 mar 1995 by flux ([EMAIL PROTECTED])
  * T line patch - display motd based on hostmask
Index: ircu2.10/ircd/m_oper.c
diff -u ircu2.10/ircd/m_oper.c:1.27 ircu2.10/ircd/m_oper.c:1.28
--- ircu2.10/ircd/m_oper.c:1.27 Tue Jul  4 12:44:38 2006
+++ ircu2.10/ircd/m_oper.c      Fri Jul 14 17:09:10 2006
@@ -20,7 +20,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  *
- * $Id: m_oper.c,v 1.27 2006/07/04 19:44:38 entrope Exp $
+ * $Id: m_oper.c,v 1.28 2006/07/15 00:09:10 entrope Exp $
  */
 
 #include "config.h"
@@ -161,7 +161,7 @@
 }
 
 /** Handle an OPER message from a server connection.
- * Usually, a server will just send a MODE <numnick> +o message
+ * Usually, a server will just send a MODE \<numnick\> +o message
  * instead.
  *
  * \a parv has the following elements:
Index: ircu2.10/ircd/m_rping.c
diff -u ircu2.10/ircd/m_rping.c:1.13 ircu2.10/ircd/m_rping.c:1.14
--- ircu2.10/ircd/m_rping.c:1.13        Tue Jul  4 19:19:31 2006
+++ ircu2.10/ircd/m_rping.c     Fri Jul 14 17:09:10 2006
@@ -20,7 +20,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  *
- * $Id: m_rping.c,v 1.13 2006/07/05 02:19:31 entrope Exp $
+ * $Id: m_rping.c,v 1.14 2006/07/15 00:09:10 entrope Exp $
  */
 
 #include "config.h"
@@ -159,8 +159,8 @@
  * \li \a parv[1] is the name of the rping target
  * \li \a parv[2] (optional) is the name of the rping source (defaults
  *   to this server)
- * \li \a parv[3] (optional) is a remark (defaults to "<No client
- *   start time>")
+ * \li \a parv[3] (optional) is a remark (defaults to "\<No client
+ *   start time\>")
  *
  * See @ref m_functions for discussion of the arguments.
  * @param[in] cptr Client that sent us the message.
Index: ircu2.10/ircd/motd.c
diff -u ircu2.10/ircd/motd.c:1.24 ircu2.10/ircd/motd.c:1.25
--- ircu2.10/ircd/motd.c:1.24   Mon Jun 26 19:05:20 2006
+++ ircu2.10/ircd/motd.c        Fri Jul 14 17:09:10 2006
@@ -23,7 +23,7 @@
  */
 /** @file
  * @brief Message-of-the-day manipulation implementation.
- * @version $Id: motd.c,v 1.24 2006/06/27 02:05:20 entrope Exp $
+ * @version $Id: motd.c,v 1.25 2006/07/15 00:09:10 entrope Exp $
  */
 #include "config.h"
 
@@ -54,7 +54,7 @@
 #include <sys/stat.h>
 
 /** Global list of messages of the day. */
-static struct {
+static struct MotdList_s {
   struct Motd*     local;     /**< Local MOTD. */
   struct Motd*     remote;    /**< Remote MOTD. */
   struct Motd*     other;     /**< MOTDs specified in configuration file. */
Index: ircu2.10/ircd/msgq.c
diff -u ircu2.10/ircd/msgq.c:1.13 ircu2.10/ircd/msgq.c:1.14
--- ircu2.10/ircd/msgq.c:1.13   Thu Apr  6 20:27:50 2006
+++ ircu2.10/ircd/msgq.c        Fri Jul 14 17:09:10 2006
@@ -18,7 +18,7 @@
  */
 /** @file
  * @brief Outbound message queue implementation.
- * @version $Id: msgq.c,v 1.13 2006/04/07 03:27:50 entrope Exp $
+ * @version $Id: msgq.c,v 1.14 2006/07/15 00:09:10 entrope Exp $
  */
 #include "config.h"
 
@@ -72,7 +72,7 @@
 };
 
 /** Global tracking data for message buffers. */
-static struct {
+static struct MQData_s {
   struct MsgBuf *msglist;      /**< list of in-use MsgBuf's */
   struct {
     unsigned int alloc;                /**< number of Msg's allocated */
Index: ircu2.10/ircd/os_generic.c
diff -u ircu2.10/ircd/os_generic.c:1.26 ircu2.10/ircd/os_generic.c:1.27
--- ircu2.10/ircd/os_generic.c:1.26     Thu Apr  6 20:27:50 2006
+++ ircu2.10/ircd/os_generic.c  Fri Jul 14 17:09:10 2006
@@ -18,7 +18,7 @@
  */
 /** @file
  * @brief Implementation of OS-dependent operations.
- * @version $Id: os_generic.c,v 1.26 2006/04/07 03:27:50 entrope Exp $
+ * @version $Id: os_generic.c,v 1.27 2006/07/15 00:09:10 entrope Exp $
  */
 #include "config.h"
 
@@ -135,6 +135,7 @@
  * @param[out] v6 Native socket address.
  * @param[in] irc IRC socket address.
  * @param[in] compat_fd If non-negative, an FD specifying address family.
+ * @param[in] family If non-zero, the address family to use.
  * @return Length of address written to \a v6.
  */
 int sockaddr_from_irc(struct sockaddr_in6 *v6, const struct irc_sockaddr *irc, 
int compat_fd, int family)
Index: ircu2.10/ircd/s_auth.c
diff -u ircu2.10/ircd/s_auth.c:1.46 ircu2.10/ircd/s_auth.c:1.47
--- ircu2.10/ircd/s_auth.c:1.46 Sun Jul  9 05:33:45 2006
+++ ircu2.10/ircd/s_auth.c      Fri Jul 14 17:09:10 2006
@@ -31,7 +31,7 @@
  */
 /** @file
  * @brief Implementation of DNS and ident lookups.
- * @version $Id: s_auth.c,v 1.46 2006/07/09 12:33:45 entrope Exp $
+ * @version $Id: s_auth.c,v 1.47 2006/07/15 00:09:10 entrope Exp $
  */
 #include "config.h"
 
@@ -106,7 +106,7 @@
 /** Array of message text (with length) pairs for AUTH status
  * messages.  Indexed using #ReportType.
  */
-static struct {
+static struct HeaderMessages_s {
   const char*  message;
   unsigned int length;
 } HeaderMessages [] = {
Index: ircu2.10/ircd/s_bsd.c
diff -u ircu2.10/ircd/s_bsd.c:1.84 ircu2.10/ircd/s_bsd.c:1.85
--- ircu2.10/ircd/s_bsd.c:1.84  Thu Apr  6 20:27:50 2006
+++ ircu2.10/ircd/s_bsd.c       Fri Jul 14 17:09:10 2006
@@ -19,7 +19,7 @@
  */
 /** @file
  * @brief Functions that now (or in the past) relied on BSD APIs.
- * @version $Id: s_bsd.c,v 1.84 2006/04/07 03:27:50 entrope Exp $
+ * @version $Id: s_bsd.c,v 1.85 2006/07/15 00:09:10 entrope Exp $
  */
 #include "config.h"
 
@@ -160,8 +160,9 @@
 /** Called when resolver query finishes.  If the DNS lookup was
  * successful, start the connection; otherwise notify opers of the
  * failure.
- * @param vptr The struct ConfItem representing the Connect block.
- * @param hp A pointer to the DNS lookup results (NULL on failure).
+ * @param[in] vptr The struct ConfItem representing the Connect block.
+ * @param[in] addr The resolved IP address (NULL on failure).
+ * @param[in] h_name The name being looked up.
  */
 static void connect_dns_callback(void* vptr, const struct irc_in_addr *addr, 
const char *h_name)
 {
Index: ircu2.10/ircd/s_conf.c
diff -u ircu2.10/ircd/s_conf.c:1.90 ircu2.10/ircd/s_conf.c:1.91
--- ircu2.10/ircd/s_conf.c:1.90 Wed Jun 28 17:41:28 2006
+++ ircu2.10/ircd/s_conf.c      Fri Jul 14 17:09:10 2006
@@ -19,7 +19,7 @@
  */
 /** @file
  * @brief ircd configuration file driver
- * @version $Id: s_conf.c,v 1.90 2006/06/29 00:41:28 entrope Exp $
+ * @version $Id: s_conf.c,v 1.91 2006/07/15 00:09:10 entrope Exp $
  */
 #include "config.h"
 
@@ -228,8 +228,9 @@
 }
 
 /** Copies a completed DNS query into its ConfItem.
- * @param vptr Pointer to struct ConfItem for the block.
- * @param hp DNS reply, or NULL if the lookup failed.
+ * @param[in] vptr Pointer to struct ConfItem for the block.
+ * @param[in] addr The resolved IP address (NULL on failure).
+ * @param[in] h_name The DNS name being resolved.
  */
 static void conf_dns_callback(void* vptr, const struct irc_in_addr *addr, 
const char *h_name)
 {
@@ -902,7 +903,7 @@
 }
 
 /** Free all memory associated with service mapping \a smap.
- * @param smap[in] The mapping to free.
+ * @param[in] smap The mapping to free.
  */
 void free_mapping(struct s_map *smap)
 {
Index: ircu2.10/ircd/whowas.c
diff -u ircu2.10/ircd/whowas.c:1.19 ircu2.10/ircd/whowas.c:1.20
--- ircu2.10/ircd/whowas.c:1.19 Thu Apr  6 20:27:50 2006
+++ ircu2.10/ircd/whowas.c      Fri Jul 14 17:09:10 2006
@@ -57,7 +57,7 @@
 
 
 /** Keeps track of whowas least-recently-used list. */
-static struct {
+static struct wwList_s {
   struct Whowas *ww_list;      /**< list of whowas structures */
   struct Whowas *ww_tail;      /**< tail of list for getting structures */
   unsigned int  ww_alloc;      /**< alloc count */
@@ -68,10 +68,10 @@
 
 /** @file
  * @brief Manipulation functions for the whowas list.
- * @version $Id: whowas.c,v 1.19 2006/04/07 03:27:50 entrope Exp $
+ * @version \$Id: whowas.c,v 1.20 2006/07/15 00:09:10 entrope Exp $
  *
  * Since the introduction of numeric nicks (at least for upstream messages,
- * like MODE +o &lt;nick>, KICK #chan &lt;nick>, KILL &lt;nick> etc), there is 
no
+ * like MODE +o \<nick\>, KICK \#chan \<nick\>, KILL \<nick\> etc), there is no
  * real important reason for a nick history anymore.
  * Nevertheless, there are two reason why we might want to keep it:
  * @li The /WHOWAS command, which is often useful to catch harassing
@@ -102,9 +102,9 @@
  * is not anymore maintained (and hopefully not used anymore either ;).
  *
  * So now we have two ways of accessing this database:
- * @li Given a &lt;nick> we can calculate a hashv and then whowashash[hashv] 
will
+ * @li Given a \<nick\> we can calculate a hashv and then whowashash[hashv] 
will
  *    point to the start of the 'hash list': all entries with the same hashv.
- *    We'll have to search this list to find the entry with the correct 
&lt;nick>.
+ *    We'll have to search this list to find the entry with the correct 
\<nick\>.
  *    Once we found the correct whowas entry, we have a pointer to the
  *    corresponding client - if still online - for nick chasing purposes.
  *    Note that the same nick can occur multiple times in the whowas history,
----------------------- End of diff -----------------------
_______________________________________________
Patches mailing list
[email protected]
http://undernet.sbg.org/mailman/listinfo/patches

Reply via email to