Documentation fix for WmudClient

docs/reference/wmud/wmud-docs.sgml

@@ -18,6 +18,7 @@
     <title>wMUD hackers' guide</title>
     <!--xi:include href="xml/types.xml"/-->
     <xi:include href="xml/utils.xml"/>
+    <xi:include href="xml/wmudclient.xml"/>
     <xi:include href="xml/configuration.xml"/>
     <xi:include href="xml/maintenance-thread.xml"/>
     <xi:include href="xml/game-thread.xml"/>

docs/reference/wmud/wmud-sections.txt

@@ -2,7 +2,40 @@
 <TITLE>WmudClient</TITLE>
 <FILE>wmudclient</FILE>
 WmudClient
+WmudClientPrivate
 WmudClientState
+WmudClientYesnoCallback
+WMUD_CLIENT
+WMUD_CLIENT_CLASS
+WMUD_CLIENT_GET_CLASS
+WMUD_IS_CLIENT
+WMUD_IS_CLIENT_CLASS
+WMUD_TYPE_CLIENT
+WMUD_TYPE_CLIENT_STATE
+wmud_client_close
+wmud_client_get_bademail
+wmud_client_get_buffer
+wmud_client_get_buffer_length
+wmud_client_get_last_recv_age
+wmud_client_get_login_fail_count
+wmud_client_get_player
+wmud_client_get_socket
+wmud_client_get_socket_source
+wmud_client_get_state
+wmud_client_get_type
+wmud_client_get_yesno_callback
+wmud_client_increase_login_fail_count
+wmud_client_new
+wmud_client_newchar_answer
+wmud_client_quitanswer
+wmud_client_set_authenticated
+wmud_client_set_bademail
+wmud_client_set_context
+wmud_client_set_player
+wmud_client_set_socket
+wmud_client_set_state
+wmud_client_set_yesno_callback
+wmud_client_state_get_type
 </SECTION>
 
 <SECTION>

wmud/wmudclient.c

@@ -25,7 +25,7 @@
 /**
  * SECTION:wmudclient
  * @short_description: wMUD Client
- * @inclide: wmudclient.h
+ * @include: wmudclient.h
  *
  * #WmudClient is for storing an active client connection
  **/
@@ -232,7 +232,7 @@ wmud_client_send(WmudClient *self, const gchar *fmt, ...)
 
 /**
  * wmud_client_close:
- * @client: the client whose connection should be dropped
+ * @self: the client whose connection should be dropped
  * @send_goodbye: if set to %TRUE, we will send a nice good-bye message to the
  *                client before dropping the connection
  *
@@ -330,10 +330,17 @@ wmud_client_set_bademail(WmudClient *self, gboolean bademail)
 	self->priv->bademail = bademail;
 }
 
+/**
+ * wmud_client_get_bademail:
+ * @client: the client whose bad e-mail status is to be retrieved
+ *
+ * Gets the bad e-mail status, e.g if the player on the other side entered a
+ * syntactically bad e-mail address
+ */
 gboolean
-wmud_client_get_bademail(WmudClient *self)
+wmud_client_get_bademail(WmudClient *client)
 {
-	return self->priv->bademail;
+	return client->priv->bademail;
 }
 
 void

wmud/wmudclient.h

@@ -19,14 +19,6 @@
 #ifndef __WMUD_WMUDCLIENT_H__
 #define __WMUD_WMUDCLIENT_H__
 
-/**
- * SECTION:wmudclient
- * @short_description: wMUD Client
- * @inclide: wmudclient.h
- *
- * #WmudClient is for storing an active client connection
- **/
-
 #include <glib-object.h>
 #include <glib.h>
 #include <gio/gio.h>
@@ -42,20 +34,26 @@
 
 /**
  * WmudClient:
- * @parent_instance: the parent GObject instance
  *
  * A connected game client
  */
 typedef struct _WmudClient WmudClient;
 typedef struct _WmudClientClass WmudClientClass;
 typedef struct _WmudClientPrivate WmudClientPrivate;
+
+/**
+ * WmudClientYesnoCallback:
+ * @client: the client who is waiting for the answer
+ * @answer: the answer itself, where TRUE means yes and FALSE means no
+ *
+ * A callback function used by yes/no questions
+ */
 typedef void (*WmudClientYesnoCallback)(WmudClient *client, gboolean answer);
 
 struct _WmudClient
 {
-	GObject  parent_instance;
-
 	/*< private >*/
+	GObject  parent_instance;
 	WmudClientPrivate *priv;
 };
 
@@ -88,4 +86,3 @@ guint32 wmud_client_get_last_recv_age(WmudClient *client);
 void wmud_client_set_context(WmudClient *client, GMainContext *context);
 
 #endif /* __WMUD_WMUDCLIENT_H__ */
-