Some docstrings.

diff --git a/lib/listener.h b/lib/listener.h
index 37e4362db7fcbf388d4c012befd501323069f6a7..1cf8c407f01ee8eb5dc550422cba4ce6bad57d6b 100644 (file)
--- a/lib/listener.h
+++ b/lib/listener.h
@@ -48,13 +48,19 @@ struct socks_method;
  * Client connection that has not been authenticated yet.
  */
 struct pending_client {
+       /** Connection to the client. */
        GIOChannel *connection;
+
+       /** Username the client has sent. */
        char *user;
+       
+       /** Password the client has sent. */
        char *password;
-       gint watch_id;
-       struct sockaddr *clientname;
-       socklen_t clientname_len;
+
+       /** The listener used for this pending client. */
        struct irc_listener *listener;
+
+       /** Socks state. */
        struct {
                struct socks_method *method;
                enum state { 
@@ -66,6 +72,8 @@ struct pending_client {
                } state;
                void *method_data;
        } socks;
+
+       /** Private data. */
        void *private_data;
 };
 

diff --git a/lib/network.h b/lib/network.h
index 51aa16fae564d8d5db1b5f7a3b32027c069f0c28..ae036a1dadb1d55ae98fab05826b41760eb94786 100644 (file)
--- a/lib/network.h
+++ b/lib/network.h
@@ -67,18 +67,29 @@ struct network_connection {
 
        /** IO Channel. */
        GIOChannel *outgoing;
+       /** Source id for output watch. */
        gint outgoing_id;
+       /** Source id for input watch. */
        gint incoming_id;
+
+       /** IConv handle used for outgoing data. */
        GIConv outgoing_iconv;
+       /** IConv handle used for incoming data. */
        GIConv incoming_iconv;
 
        union { 
                struct {
+                       /** Configuration for TCP/IP server currently connected to. */
                        struct tcp_server_config *current_server;
+                       /** Name of remote server. */
                        struct sockaddr *remote_name;
+                       /** Name of local host used for connection. */
                        struct sockaddr *local_name;
+                       /** Socket name length for remote_name and local_name. */
                        socklen_t namelen;
+                       /** Last reason for disconnect. */
                        char *last_disconnect_reason;
+                       /** Source ID for function that regularly pings the network. */
                        gint ping_id;
                } tcp;
                
@@ -101,6 +112,7 @@ typedef void (*network_log_fn) (enum log_level, void *, const char *);
  * An IRC network
  */
 struct irc_network {
+       /** Global data. */
        struct global *global;
 
        /** Configuration. */

diff --git a/lib/state.h b/lib/state.h
index 2cb94d2d6cb822af463d56a1c27cfca54eb7f44b..122316eed154af111daca1cbd01fb5f441da7802 100644 (file)
--- a/lib/state.h
+++ b/lib/state.h
@@ -104,14 +104,21 @@ struct channel_state {
  */
 struct network_state 
 {
+       /** Private data to be used by whatever code is using network_state. */
        void *userdata;
+       /** Function to use for logging changes and abnormalities. */
        void (*log) (enum log_level l,
                                 void *userdata,
                                 const char *msg);
+       /** List of known channels. */
        GList *channels;
+       /** List of known nicks. */
        GList *nicks;
+       /** Information for the user itself. */
        struct network_nick me;
+       /** Network static info. */
        struct irc_network_info info;
+       /** Whether or not the user is currently away. */
        gboolean is_away;
 };
 

diff --git a/src/ctrlproxy.h b/src/ctrlproxy.h
index 11dd3c4f463f5b63ec3c4d7757bc072effcdee7b..6b8c5f411fb186e7bbe4386957ad4fff73db9a29 100644 (file)
--- a/src/ctrlproxy.h
+++ b/src/ctrlproxy.h
@@ -89,8 +89,11 @@ struct global {
  * Plugin description. Required to be defined by all plugins.
  */
 struct plugin_ops {
+       /** API version this plugin uses. */
        int version;
+       /** Name of the plugin. */
        char *name;
+       /** Function that initializes the plugin. */
        gboolean (*init) (void);
 };
 

diff --git a/src/plugins.h b/src/plugins.h
index c60babc7749ce19ee9a5e57cf640777efedb62ff..e5c8237f21526b60c6fe47dbd67c82c5718fa9f7 100644 (file)
--- a/src/plugins.h
+++ b/src/plugins.h
@@ -29,7 +29,9 @@
  * A plugin.
  */
 struct plugin {
+       /** Plugin handle */
        GModule *module;
+       /** Plugin private data. */
        void *data;
        /** Plugin operations */
        struct plugin_ops *ops;

diff --git a/src/redirect.c b/src/redirect.c
index 0e777c190491bdb95428ac266846b5b9985e3d48..0c5d71c8df6289d2fc1c85d45cfecfa83f8afd11 100644 (file)
--- a/src/redirect.c
+++ b/src/redirect.c
@@ -38,12 +38,18 @@ static struct query_stack *stack = NULL;
  * IRC Query done by a client
  */
 struct query {
+       /** Command name. */
        char *name;
+
+       /** Possible replies */
        int replies[20];
+       /** Possible replies that are the last reply to this command. */
        int end_replies[20];
+       /** Possible errors. */
        int errors[20];
        /* Should add this query to the stack. return TRUE if this has 
         * been done successfully, FALSE otherwise */
+       /** Function for handling the responses. */
        int (*handle) (const struct irc_line *, const struct irc_network *n, struct irc_client *c, struct query *);
 };
 

diff --git a/src/repl.h b/src/repl.h
index cc4ea4f89eb4d6db1dbc998395f6a9d06cd68c51..ae7e04648d0875bd137c962f78ec855f39c238ef 100644 (file)
--- a/src/repl.h
+++ b/src/repl.h
@@ -29,7 +29,9 @@
  * A replication backend
  */
 struct replication_backend {
+       /** Name of the backend, as can be specified in replication=. */
        const char *name;
+       /** Replication function. */
        void (*replication_fn) (struct irc_client *);
 };