Minor documentation fixes
authorMyhailo Danylenko <isbear@ukrpost.net>
Mon, 19 Nov 2012 19:11:25 +0200
changeset 643 e7ef923056d7
parent 642 3810c9e91f8e
child 644 4fc5eab77197
Minor documentation fixes
docs/reference/loudmouth-sections.txt
loudmouth/lm-connection.h
loudmouth/lm-error.h
loudmouth/lm-message-handler.c
loudmouth/lm-message.h
loudmouth/lm-proxy.c
--- a/docs/reference/loudmouth-sections.txt	Thu Nov 15 12:18:09 2012 -0800
+++ b/docs/reference/loudmouth-sections.txt	Mon Nov 19 19:11:25 2012 +0200
@@ -46,6 +46,7 @@
 
 <SECTION>
 <FILE>lm-message-handler</FILE>
+LmMessageHandler
 LmHandleMessageFunction
 lm_message_handler_new
 lm_message_handler_invalidate
--- a/loudmouth/lm-connection.h	Thu Nov 15 12:18:09 2012 -0800
+++ b/loudmouth/lm-connection.h	Mon Nov 19 19:11:25 2012 +0200
@@ -85,10 +85,13 @@
 
 /**
  * LmDisconnectReason:
- * @LM_DISCONNECT_REASON_OK:  * @LM_DISCONNECT_REASON_PING_TIME_OUT: Connection to the server timed out.
+ * @LM_DISCONNECT_REASON_OK:
+ * @LM_DISCONNECT_REASON_PING_TIME_OUT: Connection to the server timed out.
  * @LM_DISCONNECT_REASON_HUP: The socket emitted that the connection was hung up.
  * @LM_DISCONNECT_REASON_ERROR: A generic error somewhere in the transport layer.
- * @LM_DISCONNECT_REASON_RESOURCE_CONFLICT:  * @LM_DISCONNECT_REASON_INVALID_XML:  * @LM_DISCONNECT_REASON_UNKNOWN: An unknown error.
+ * @LM_DISCONNECT_REASON_RESOURCE_CONFLICT:
+ * @LM_DISCONNECT_REASON_INVALID_XML:
+ * @LM_DISCONNECT_REASON_UNKNOWN: An unknown error.
  *
  * Sent with #LmDisconnectFunction to describe why a connection was closed.
  */
--- a/loudmouth/lm-error.h	Thu Nov 15 12:18:09 2012 -0800
+++ b/loudmouth/lm-error.h	Mon Nov 19 19:11:25 2012 +0200
@@ -41,7 +41,8 @@
  * @LM_ERROR_CONNECTION_NOT_OPEN: Connection not open when trying to send a message
  * @LM_ERROR_CONNECTION_OPEN: Connection is already open when trying to open it again.
  * @LM_ERROR_AUTH_FAILED: Authentication failed while opening connection
- * @LM_ERROR_CONNECTION_FAILED:  *
+ * @LM_ERROR_CONNECTION_FAILED:
+ * 
  * Describes the problem of the error.
  */
 typedef enum {
--- a/loudmouth/lm-message-handler.c	Thu Nov 15 12:18:09 2012 -0800
+++ b/loudmouth/lm-message-handler.c	Mon Nov 19 19:11:25 2012 +0200
@@ -145,7 +145,7 @@
 
 /**
  * lm_message_handler_unref:
- * @handler: an #LmMessagHandler
+ * @handler: an #LmMessageHandler
  *
  * Removes a reference from @handler. When no more references are present the
  * handler is freed.
--- a/loudmouth/lm-message.h	Thu Nov 15 12:18:09 2012 -0800
+++ b/loudmouth/lm-message.h	Mon Nov 19 19:11:25 2012 +0200
@@ -44,7 +44,15 @@
  * @LM_MESSAGE_TYPE_IQ: an info/query element, <iq/>
  * @LM_MESSAGE_TYPE_STREAM: the stream:stream element, you probably don't need to create a message of this type.
  * @LM_MESSAGE_TYPE_STREAM_ERROR: a stream:error element
- * @LM_MESSAGE_TYPE_STREAM_FEATURES:  * @LM_MESSAGE_TYPE_AUTH:  * @LM_MESSAGE_TYPE_CHALLENGE:  * @LM_MESSAGE_TYPE_RESPONSE:  * @LM_MESSAGE_TYPE_SUCCESS:  * @LM_MESSAGE_TYPE_FAILURE:  * @LM_MESSAGE_TYPE_PROCEED:  * @LM_MESSAGE_TYPE_STARTTLS:  * @LM_MESSAGE_TYPE_UNKNOWN: incoming message is of some unknown type.
+ * @LM_MESSAGE_TYPE_STREAM_FEATURES:
+ * @LM_MESSAGE_TYPE_AUTH:
+ * @LM_MESSAGE_TYPE_CHALLENGE:
+ * @LM_MESSAGE_TYPE_RESPONSE:
+ * @LM_MESSAGE_TYPE_SUCCESS:
+ * @LM_MESSAGE_TYPE_FAILURE:
+ * @LM_MESSAGE_TYPE_PROCEED:
+ * @LM_MESSAGE_TYPE_STARTTLS:
+ * @LM_MESSAGE_TYPE_UNKNOWN: incoming message is of some unknown type.
  *
  * Describes what type of message a message is. This maps directly to top level elements in the jabber protocol.
  */
@@ -69,7 +77,8 @@
  * LmMessageSubType:
  * @LM_MESSAGE_SUB_TYPE_NOT_SET: the default. No "type" attribute will be sent.
  * @LM_MESSAGE_SUB_TYPE_AVAILABLE: presence is available, applies to message type "presence"
- * @LM_MESSAGE_SUB_TYPE_NORMAL:  * @LM_MESSAGE_SUB_TYPE_CHAT: message is a chat message, applies to message type "message"
+ * @LM_MESSAGE_SUB_TYPE_NORMAL:
+ * @LM_MESSAGE_SUB_TYPE_CHAT: message is a chat message, applies to message type "message"
  * @LM_MESSAGE_SUB_TYPE_GROUPCHAT: message is a group chat message, applies to message type "message"
  * @LM_MESSAGE_SUB_TYPE_HEADLINE: message is a headline message, applies to message type "message"
  * @LM_MESSAGE_SUB_TYPE_UNAVAILABLE: presence is unavailable, applies to message type "presence"
--- a/loudmouth/lm-proxy.c	Thu Nov 15 12:18:09 2012 -0800
+++ b/loudmouth/lm-proxy.c	Mon Nov 19 19:11:25 2012 +0200
@@ -316,7 +316,7 @@
 /**
  * lm_proxy_set_type
  * @proxy: an #LmProxy
- * @type: an LmProxyType
+ * @type: an #LmProxyType
  *
  * Sets the proxy type for @proxy to @type.
  **/