Committer : entrope
CVSROOT : /cvsroot/undernet-ircu
Module : ircu2.10
Commit time: 2004-09-27 22:34:53 UTC
Modified files:
include/struct.h
Log message:
Doxyfy struct.h.
---------------------- diff included ----------------------
Index: ircu2.10/include/struct.h
diff -u ircu2.10/include/struct.h:1.5 ircu2.10/include/struct.h:1.6
--- ircu2.10/include/struct.h:1.5 Sun May 16 10:59:40 2004
+++ ircu2.10/include/struct.h Mon Sep 27 15:34:42 2004
@@ -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: struct.h,v 1.5 2004/05/16 17:59:40 entrope Exp $
+ */
+/* @file
+ * @brief Structure definitions for users and servers.
+ * @version $Id: struct.h,v 1.6 2004/09/27 22:34:42 entrope Exp $
*/
#ifndef INCLUDED_struct_h
#define INCLUDED_struct_h
@@ -36,47 +38,46 @@
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 */
- 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 */
- char username[USERLEN + 1];
- char host[HOSTLEN + 1];
- char realhost[HOSTLEN + 1];
- char account[ACCOUNTLEN + 1];
- time_t acc_create;
+ 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; /**< 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 */
+ char username[USERLEN + 1]; /**< remote account name */
+ 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 */
----------------------- End of diff -----------------------
