Fixed the SECTION parts of the inlined docs so that gtk-doc finds them.
authorMikael Hallendal <micke@imendio.com>
Sat, 21 Jun 2008 17:12:59 +0200
changeset 420 f40434cca022
parent 419 d865cbe1309d
child 421 2a91651d22de
Fixed the SECTION parts of the inlined docs so that gtk-doc finds them. Got help from Stefan Kost on IRC to figure out that SECTION needs to be the same as <FILE> in the loudmouth-sections.txt file.
loudmouth/lm-connection.c
loudmouth/lm-error.c
loudmouth/lm-message-handler.c
loudmouth/lm-message-node.c
loudmouth/lm-message.c
loudmouth/lm-proxy.c
loudmouth/lm-ssl.h
loudmouth/lm-utils.c
--- a/loudmouth/lm-connection.c	Sat Jun 21 16:59:56 2008 +0200
+++ b/loudmouth/lm-connection.c	Sat Jun 21 17:12:59 2008 +0200
@@ -21,7 +21,7 @@
  */
 
 /**
- * SECTION:LmConnection
+ * SECTION:lm-connection
  * @Short_description: A client connection to the server
  * 
  * An example of how to use Loudmouth with the synchronous API.
@@ -29,18 +29,18 @@
  * int
  * main (int argc, char **argv)
  * {
- *         LmConnection *connection;
- *         GError       *error = NULL;
- *         gint          i;
- * 	LmMessage    *m;
+ *       LmConnection *connection;
+ *       GError       *error = NULL;
+ *       gint          i;
+ * 	 LmMessage    *m;
+ *
+ *       connection = lm_connection_new ("myserver");
  * 
- *         connection = lm_connection_new ("myserver");
+ *       if (!lm_connection_open_and_block (connection, &amp;error)) {
+ *               g_error ("Failed to open: &percnt;s\n", error->message);
+ *       }
  * 
- *         if (!lm_connection_open_and_block (connection, &amp;error)) {
- *                 g_error ("Failed to open: &percnt;s\n", error->message);
- *         }
- * 
- * 	if (!lm_connection_authenticate_and_block (connection,
+ *       if (!lm_connection_authenticate_and_block (connection,
  * 						   "username", "password", 
  * 						   "resource",
  * 						   &amp;error)) {
--- a/loudmouth/lm-error.c	Sat Jun 21 16:59:56 2008 +0200
+++ b/loudmouth/lm-error.c	Sat Jun 21 17:12:59 2008 +0200
@@ -19,7 +19,7 @@
  */
 
 /**
- * SECTION:LmError
+ * SECTION:lm-error
  * @Short_description: Error reporting.
  */
 
--- a/loudmouth/lm-message-handler.c	Sat Jun 21 16:59:56 2008 +0200
+++ b/loudmouth/lm-message-handler.c	Sat Jun 21 17:12:59 2008 +0200
@@ -19,7 +19,7 @@
  */
 
 /**
- * SECTION:LmMessageHandler
+ * SECTION:lm-message-handler
  * @Short_description: A handler for incoming messages.
  * 
  *  A handler can be registered to listen to incoming messages with lm_connection_register_message_handler(). When a message is recieved the handlers of the correct type will be called.
--- a/loudmouth/lm-message-node.c	Sat Jun 21 16:59:56 2008 +0200
+++ b/loudmouth/lm-message-node.c	Sat Jun 21 17:12:59 2008 +0200
@@ -19,7 +19,7 @@
  */
 
 /**
- * SECTION:LmMessageNode
+ * SECTION:lm-message-node
  * @Short_description: A node in the message tree
  */
 
--- a/loudmouth/lm-message.c	Sat Jun 21 16:59:56 2008 +0200
+++ b/loudmouth/lm-message.c	Sat Jun 21 17:12:59 2008 +0200
@@ -19,7 +19,7 @@
  */
 
 /**
- * SECTION:LmMessage
+ * SECTION:lm-message
  * @Short_description: A message is built up like a tree of message nodes.
  * 
  * Represents a message that can be sent with lm_connection_send(), lm_connection_send_with_reply() or lm_connection_send_with_reply_and_block(). Either use lm_message_new() or lm_message_new_with_subtype() to create a message. You need to call lm_message_unref() when are finished with it.
--- a/loudmouth/lm-proxy.c	Sat Jun 21 16:59:56 2008 +0200
+++ b/loudmouth/lm-proxy.c	Sat Jun 21 17:12:59 2008 +0200
@@ -20,7 +20,7 @@
  */
 
 /**
- * SECTION:LmProxy
+ * SECTION:lm-proxy
  * @Short_description: API for the proxy support in Loudmouth
  * 
  * Use this together with an #LmConnection to get the connection to use connect through a proxy. Example of how to use the #LmProxy API.
--- a/loudmouth/lm-ssl.h	Sat Jun 21 16:59:56 2008 +0200
+++ b/loudmouth/lm-ssl.h	Sat Jun 21 17:12:59 2008 +0200
@@ -19,7 +19,7 @@
  */
 
 /**
- * SECTION:LmSSL
+ * SECTION:lm-ssl
  * @Short_description: SSL struct for SSL support in Loudmouth
  * 
  * Use this together with an #LmConnection to get the connection to use SSL. Example of how to use the #LmSSL API.
--- a/loudmouth/lm-utils.c	Sat Jun 21 16:59:56 2008 +0200
+++ b/loudmouth/lm-utils.c	Sat Jun 21 17:12:59 2008 +0200
@@ -19,7 +19,8 @@
  */
 
 /**
- * SECTION:Miscellaneous Utility Functions
+ * SECTION:lm-utils
+ * @Short_description: Miscellaneous Utility Functions
  * 
  * Functions to help application developers when writing XMPP applications using Loudmouth.
  */