From 894b9bfafde93e69b2c0ffcff94233cd6c4e9568 Mon Sep 17 00:00:00 2001
From: Gergely Polonkai <gergely@polonkai.eu>
Date: Tue, 18 Jun 2013 16:42:42 +0200
Subject: [PATCH] Fixed GTK-DOC related errors

---
 docs/reference/wmud/wmud-docs.sgml    |  7 +++----
 docs/reference/wmud/wmud-sections.txt | 15 ++++++++++-----
 wmud/configuration.h                  | 18 ++++++++++++++++--
 wmud/game-networking.c                |  2 ++
 wmud/menu.c                           |  1 +
 wmud/wmudclient.h                     |  9 +++++++++
 6 files changed, 41 insertions(+), 11 deletions(-)

diff --git a/docs/reference/wmud/wmud-docs.sgml b/docs/reference/wmud/wmud-docs.sgml
index 967edd1..bd55512 100644
--- a/docs/reference/wmud/wmud-docs.sgml
+++ b/docs/reference/wmud/wmud-docs.sgml
@@ -16,7 +16,7 @@
 
   <chapter>
     <title>wMUD hackers' guide</title>
-    <xi:include href="xml/types.xml"/>
+    <!--xi:include href="xml/types.xml"/-->
     <xi:include href="xml/utils.xml"/>
     <xi:include href="xml/configuration.xml"/>
     <xi:include href="xml/maintenance-thread.xml"/>
@@ -25,9 +25,8 @@
     <xi:include href="xml/interpreter.xml"/>
     <xi:include href="xml/db.xml"/>
     <xi:include href="xml/player.xml"/>
-    <xi:include href="xml/menu.xml"/>
-    <xi:include href="xml/world.xml"/>
-
+    <!--xi:include href="xml/menu.xml"/-->
+    <!--xi:include href="xml/world.xml"/-->
   </chapter>
   <!--chapter id="object-tree">
     <title>Object Hierarchy</title>
diff --git a/docs/reference/wmud/wmud-sections.txt b/docs/reference/wmud/wmud-sections.txt
index 2da1e62..199bfb7 100644
--- a/docs/reference/wmud/wmud-sections.txt
+++ b/docs/reference/wmud/wmud-sections.txt
@@ -1,6 +1,14 @@
 <SECTION>
-<TITLE>wMUD's Data Types</TITLE>
-<FILE>types</FILE>
+<TITLE>WmudClient</TITLE>
+<FILE>wmudclient</FILE>
+WmudClient
+WmudClientState
+</SECTION>
+
+<SECTION>
+<TITLE>WmudPlayer</TITLE>
+<FILE>wmudplayer</FILE>
+WmudPlayer
 </SECTION>
 
 <SECTION>
@@ -29,8 +37,6 @@ wmud_maintenance_init
 <SECTION>
 <TITLE></TITLE>
 <FILE>game-thread</FILE>
-wmudClientState
-wmudClient
 elapsed_seconds
 elapsed_cycle
 game_context
@@ -71,7 +77,6 @@ wmud_db_save_player
 <SECTION>
 <TITLE></TITLE>
 <FILE>player</FILE>
-wmudPlayer
 players
 wmud_player_dup
 wmud_player_free
diff --git a/wmud/configuration.h b/wmud/configuration.h
index dd9e8b2..1846776 100644
--- a/wmud/configuration.h
+++ b/wmud/configuration.h
@@ -18,6 +18,14 @@ GQuark wmud_config_error_quark();
  * @WMUD_CONFIG_ERROR_NOEMAIL: Indicates that the config file doesn't contain
  *     an administrator e-mail address
  * @WMUD_CONFIG_ERROR_REUSE: configuration data is reused (non-NULL)
+ * @WMUD_CONFIG_ERROR_NOSMTP: Indicates that the config file read doesn't
+ *     contain an [SMTP] section
+ * @WMUD_CONFIG_ERROR_NOSMTPSERVER: Indicates that the config file read doesn't
+ *     contain an SMTP server address
+ * @WMUD_CONFIG_ERROR_NOSMTPSENDER: Indicates that the config file read doesn't
+ *     contain an SMTP sender address
+ * @WMUD_CONFIG_ERROR_NODATABASE: Indicates that the config file read doesn't
+ *     contain a [database] section
  *
  * Error codes returned by configuration file parsing functions.
  */
@@ -36,9 +44,15 @@ typedef enum {
 /**
  * ConfigData:
  * @port: the port number of the game interface to listen on
- * @database_file: the database file of the world associated with this
- *                 configuration
+ * @database_dsn: the data source name for the world associated with this
+ *     configuration
  * @admin_email: the world administrator's e-mail address
+ * @smtp_server: the SMTP server address to send mails through
+ * @smtp_tls: defines wether a TLS connection should be used for the SMTP
+ *     server
+ * @smtp_username: the username to use while authenticating to the SMTP server
+ * @smtp_password: the password to use while authenticating to the SMTP server
+ * @smtp_sender: the sender address who sends the outgoing mails
  */
 typedef struct _ConfigData {
 	guint port;
diff --git a/wmud/game-networking.c b/wmud/game-networking.c
index 686b55d..bcf7aee 100644
--- a/wmud/game-networking.c
+++ b/wmud/game-networking.c
@@ -51,6 +51,7 @@ struct AcceptData {
 
 /**
  * clients:
+ *
  * The full #GSList of the currently connected #WmudClient objects.
  */
 GSList *clients = NULL;
@@ -249,6 +250,7 @@ game_source_callback(GSocket *socket, GIOCondition condition, struct AcceptData
  * wmud_networking_init:
  * @port_number: the port number on which the game listener should listen
  * @game_context: the #GMainContext of the game thread
+ * @menu_items: a #GSList of menu items to present to the client
  * @err: the GError in which possible errors will be reported
  *
  * Initializes the game network listener
diff --git a/wmud/menu.c b/wmud/menu.c
index d7e6d3b..932bfb8 100644
--- a/wmud/menu.c
+++ b/wmud/menu.c
@@ -38,6 +38,7 @@ GHashTable *mcmd_table = NULL;
 
 /**
  * game_menu:
+ *
  * The list of menu items to display after a successful login
  */
 GSList *game_menu = NULL;
diff --git a/wmud/wmudclient.h b/wmud/wmudclient.h
index 81ded4f..5f157bf 100644
--- a/wmud/wmudclient.h
+++ b/wmud/wmudclient.h
@@ -19,6 +19,14 @@
 #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>
@@ -34,6 +42,7 @@
 
 /**
  * WmudClient:
+ * @parent_instance: the parent GObject instance
  *
  * A connected game client
  */