X-Git-Url: http://git.pk910.de/?a=blobdiff_plain;f=include%2Fstruct.h;h=cd2712c931c8b8897b0b247c70c897ca90a7ccf3;hb=refs%2Fheads%2Fupstream-ssl;hp=015ae0f744418cebc953c3c1dc1aca301f6fa823;hpb=5f8c9f41ca145bb7d94dd2c608da613bbeb8b35b;p=ircu2.10.12-pk.git

diff --git a/include/struct.h b/include/struct.h
index 015ae0f..cd2712c 100644
--- a/include/struct.h
+++ b/include/struct.h
@@ -17,8 +17,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 Structure definitions for users and servers.
+ * @version $Id$
  */
 #ifndef INCLUDED_struct_h
 #define INCLUDED_struct_h
@@ -36,47 +38,52 @@ struct User;
 struct Membership;
 struct SLink;
 
+/** Describes a server on the network. */
 struct Server {
-  struct Server*  nexts;
-  struct Client*  up;           /* Server one closer to me */
-  struct DLink*   down;         /* List with downlink servers */
-  struct DLink*   updown;       /* own Dlink in up->serv->down struct */
-  struct Client** client_list;  /* List with client pointers on this server */
-  struct User*    user;         /* who activated this connection */
-  time_t          timestamp;    /* Remotely determined connect try time */
-  time_t          ghost;        /* Local time at which a new server
+  struct Client*  up;           /**< Server one closer to me */
+  struct DLink*   down;         /**< List with downlink servers */
+  struct DLink*   updown;       /**< own Dlink in up->serv->down struct */
+  struct Client** client_list;  /**< List with client pointers on this server */
+  struct User*    user;         /**< who activated this connection */
+  time_t          timestamp;    /**< Remotely determined connect try time */
+  time_t          ghost;        /**< Local time at which a new server
                                    caused a Ghost */
-  int             lag;          /* Approximation of the amount of lag to this server */                          
-  unsigned int    clients;      /* Number of clients on the network */
-  unsigned short  prot;         /* Major protocol */
-  unsigned short  nn_last;      /* Last numeric nick for p9 servers only */
-  unsigned int    nn_mask;      /* [Remote] FD_SETSIZE - 1 */
-  char          nn_capacity[4]; /* numeric representation of server capacity */
-  
-  int            asll_rtt;     /* AsLL round-trip time */
-  int            asll_to;      /* AsLL upstream lag */
-  int            asll_from;    /* AsLL downstream lag */
+  int             lag;          /**< Approximation of the amount of lag to this server */
+  unsigned int    clients;      /**< Number of clients on the server */
+  unsigned short  prot;         /**< Major protocol */
+  unsigned int    nn_mask;      /**< Number of clients supported by server, minus 1 */
+  char          nn_capacity[4]; /**< Numeric representation of server capacity */
+
+  int            asll_rtt;      /**< AsLL round-trip time */
+  int            asll_to;       /**< AsLL upstream lag */
+  int            asll_from;     /**< AsLL downstream lag */
+  time_t         asll_last;     /**< Last time we sent or received an AsLL ping */
 
-  char *last_error_msg;         /* Allocated memory with last message receive with an ERROR */
-  char by[NICKLEN + 1];
+  char *last_error_msg;         /**< Allocated memory with last message receive with an ERROR */
+  char by[NICKLEN + 1];         /**< Numnick of client who requested the link */
 };
 
+/** Describes a user on the network. */
 struct User {
-  struct User*       nextu;
-  struct Client*     server;         /* client structure of server */
-  struct Membership* channel;        /* chain of channel pointer blocks */
-  struct SLink*      invited;        /* chain of invite pointer blocks */
-  struct SLink*      silence;        /* chain of silence pointer blocks */
-  char*              away;           /* pointer to away message */
-  time_t             last;
-  unsigned int       refcnt;          /* Number of times this block is referenced */
-  unsigned int       joined;          /* number of channels joined */
-  unsigned int       invites;         /* Number of channels we've been invited to */
+  struct Client*     server;         /**< client structure of server */
+  struct Membership* channel;        /**< chain of channel pointer blocks */
+  struct SLink*      invited;        /**< chain of invite pointer blocks */
+  struct Ban*        silence;        /**< chain of silence pointer blocks */
+  char*              away;           /**< pointer to away message */
+  time_t             last;           /**< last time user sent a message */
+  unsigned int       refcnt;         /**< Number of times this block is referenced */
+  unsigned int       joined;         /**< number of channels joined */
+  unsigned int       invites;        /**< Number of channels we've been invited to */
+  /** Remote account name.  Before registration is complete, this is
+   * either empty or contains the username from the USER command.
+   * After registration, that may be prefixed with ~ or it may be
+   * overwritten with the ident response.
+   */
   char               username[USERLEN + 1];
-  char               host[HOSTLEN + 1];
-  char               realhost[HOSTLEN + 1];
-  char               account[ACCOUNTLEN + 1];
-  time_t	     acc_create;
+  char               host[HOSTLEN + 1];       /**< displayed hostname */
+  char               realhost[HOSTLEN + 1];   /**< actual hostname */
+  char               account[ACCOUNTLEN + 1]; /**< IRC account name */
+  time_t	     acc_create;              /**< IRC account timestamp */
 };
 
 #endif /* INCLUDED_struct_h */