Fixed up the documentation for 1.4.3 [#27]
Went over the documentation and made sure that the API docs are back to 100% documented.
[#27 responsible:Hallski state:resolved]
--- a/docs/reference/.gitignore Wed Oct 29 17:30:01 2008 +0100
+++ b/docs/reference/.gitignore Wed Oct 29 21:53:19 2008 +0100
@@ -2,6 +2,7 @@
html.stamp
loudmouth-decl-list.txt
loudmouth-decl.txt
+loudmouth-undeclared.txt
loudmouth-undocumented.txt
loudmouth-unused.txt
loudmouth.args
--- a/docs/reference/Makefile.am Wed Oct 29 17:30:01 2008 +0100
+++ b/docs/reference/Makefile.am Wed Oct 29 21:53:19 2008 +0100
@@ -47,7 +47,7 @@
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=base64.h md5.h lm-internals.h lm-sha.h lm-parser.h lm-sock.h lm-socket.h lm-message-queue.h lm-ssl-base.h lm-ssl-internals.h loudmouth.h lm-sasl.h lm-misc.h
+IGNORE_HFILES=asyncns.h base64.h md5.h lm-internals.h lm-sha.h lm-parser.h lm-sock.h lm-socket.h lm-message-queue.h lm-ssl-base.h lm-ssl-internals.h loudmouth.h lm-sasl.h lm-misc.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
--- a/docs/reference/loudmouth-sections.txt Wed Oct 29 17:30:01 2008 +0100
+++ b/docs/reference/loudmouth-sections.txt Wed Oct 29 21:53:19 2008 +0100
@@ -107,6 +107,9 @@
lm_ssl_new
lm_ssl_is_supported
lm_ssl_get_fingerprint
+lm_ssl_use_starttls
+lm_ssl_get_use_starttls
+lm_ssl_get_require_starttls
lm_ssl_ref
lm_ssl_unref
</SECTION>
--- a/docs/reference/tmpl/lm-connection.sgml Wed Oct 29 17:30:01 2008 +0100
+++ b/docs/reference/tmpl/lm-connection.sgml Wed Oct 29 21:53:19 2008 +0100
@@ -104,12 +104,12 @@
Sent with #LmDisconnectFunction to describe why a connection was closed.
</para>
-@LM_DISCONNECT_REASON_OK:
+@LM_DISCONNECT_REASON_OK: User requested disconnect.
@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_RESOURCE_CONFLICT: Another connection was made to the server with the same resource.
+@LM_DISCONNECT_REASON_INVALID_XML: Invalid XML was sent from the client.
@LM_DISCONNECT_REASON_UNKNOWN: An unknown error.
<!-- ##### ENUM LmConnectionState ##### -->
--- a/docs/reference/tmpl/lm-error.sgml Wed Oct 29 17:30:01 2008 +0100
+++ b/docs/reference/tmpl/lm-error.sgml Wed Oct 29 21:53:19 2008 +0100
@@ -6,7 +6,7 @@
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+N/A
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -33,7 +33,7 @@
@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: Connection failed to open.
<!-- ##### MACRO LM_ERROR ##### -->
<para>
--- a/docs/reference/tmpl/lm-message-node.sgml Wed Oct 29 17:30:01 2008 +0100
+++ b/docs/reference/tmpl/lm-message-node.sgml Wed Oct 29 21:53:19 2008 +0100
@@ -6,7 +6,7 @@
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+Represents a node in the #LmMessage tree. These map to XML nodes in the XMPP protocol.
</para>
<!-- ##### SECTION See_Also ##### -->
--- a/docs/reference/tmpl/lm-message.sgml Wed Oct 29 17:30:01 2008 +0100
+++ b/docs/reference/tmpl/lm-message.sgml Wed Oct 29 21:53:19 2008 +0100
@@ -20,11 +20,11 @@
<!-- ##### STRUCT LmMessage ##### -->
<para>
-Struct
+The LmMessage struct
</para>
-@node:
-@priv:
+@node: The root node of the message, you can also use lm_message_get_node() to retrieve this.
+@priv: A pointer to message private data. Should never be touched from application code.
<!-- ##### ENUM LmMessageType ##### -->
<para>
@@ -36,14 +36,14 @@
@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_STREAM_FEATURES: Internal
+@LM_MESSAGE_TYPE_AUTH: Internal
+@LM_MESSAGE_TYPE_CHALLENGE: Internal
+@LM_MESSAGE_TYPE_RESPONSE: Internal
+@LM_MESSAGE_TYPE_SUCCESS: Internal
+@LM_MESSAGE_TYPE_FAILURE: Internal
+@LM_MESSAGE_TYPE_PROCEED: Internal
+@LM_MESSAGE_TYPE_STARTTLS: Internal
@LM_MESSAGE_TYPE_UNKNOWN: incoming message is of some unknown type.
<!-- ##### ENUM LmMessageSubType ##### -->
@@ -53,7 +53,7 @@
@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_NORMAL: a normal message.
@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"
--- a/docs/reference/tmpl/lm-ssl.sgml Wed Oct 29 17:30:01 2008 +0100
+++ b/docs/reference/tmpl/lm-ssl.sgml Wed Oct 29 21:53:19 2008 +0100
@@ -102,6 +102,34 @@
@Returns:
+<!-- ##### FUNCTION lm_ssl_use_starttls ##### -->
+<para>
+
+</para>
+
+@ssl:
+@use_starttls:
+@require_starttls:
+
+
+<!-- ##### FUNCTION lm_ssl_get_use_starttls ##### -->
+<para>
+
+</para>
+
+@ssl:
+@Returns:
+
+
+<!-- ##### FUNCTION lm_ssl_get_require_starttls ##### -->
+<para>
+
+</para>
+
+@ssl:
+@Returns:
+
+
<!-- ##### FUNCTION lm_ssl_ref ##### -->
<para>
--- a/docs/reference/tmpl/lm-utils.sgml Wed Oct 29 17:30:01 2008 +0100
+++ b/docs/reference/tmpl/lm-utils.sgml Wed Oct 29 21:53:19 2008 +0100
@@ -2,7 +2,7 @@
Miscellaneous Utility Functions
<!-- ##### SECTION Short_Description ##### -->
-
+Various helper functions.
<!-- ##### SECTION Long_Description ##### -->
<para>
--- a/loudmouth/lm-connection.c Wed Oct 29 17:30:01 2008 +0100
+++ b/loudmouth/lm-connection.c Wed Oct 29 21:53:19 2008 +0100
@@ -1551,7 +1551,9 @@
*
* Get the keep alive rate, in seconds. Zero is returned if no keep alive rate has been set.
*
- * Since 1.3.5
+ * Since 1.4.0
+ *
+ * Return value: The keep alive rate in seconds.
**/
guint
lm_connection_get_keep_alive_rate (LmConnection *connection)
@@ -1720,7 +1722,7 @@
*
* Fetches the port that @connection is using.
*
- * Return value:
+ * Return value: The port used.
**/
guint
lm_connection_get_port (LmConnection *connection)
--- a/loudmouth/lm-error.c Wed Oct 29 17:30:01 2008 +0100
+++ b/loudmouth/lm-error.c Wed Oct 29 21:53:19 2008 +0100
@@ -22,6 +22,13 @@
#include <glib/gerror.h>
#include "lm-error.h"
+/**
+ * lm_error_quark:
+ *
+ * Returns the Loudmouth #GError domain quark.
+ *
+ * Return value: The Loudmouth domain quark used by #GError.
+ */
GQuark
lm_error_quark (void)
{
--- a/loudmouth/lm-error.h Wed Oct 29 17:30:01 2008 +0100
+++ b/loudmouth/lm-error.h Wed Oct 29 21:53:19 2008 +0100
@@ -35,7 +35,7 @@
LM_ERROR_CONNECTION_NOT_OPEN,
LM_ERROR_CONNECTION_OPEN,
LM_ERROR_AUTH_FAILED,
- LM_ERROR_CONNECTION_FAILED
+ LM_ERROR_CONNECTION_FAILED
} LmError;
GQuark lm_error_quark (void) G_GNUC_CONST;
--- a/loudmouth/lm-message-node.c Wed Oct 29 17:30:01 2008 +0100
+++ b/loudmouth/lm-message-node.c Wed Oct 29 21:53:19 2008 +0100
@@ -128,7 +128,7 @@
*
* Retrieves the value of @node.
*
- * Return value:
+ * Return value: The value of the node or %NULL.
**/
const gchar *
lm_message_node_get_value (LmMessageNode *node)
--- a/loudmouth/lm-message.c Wed Oct 29 17:30:01 2008 +0100
+++ b/loudmouth/lm-message.c Wed Oct 29 21:53:19 2008 +0100
@@ -288,7 +288,7 @@
/**
* lm_message_get_sub_type:
- * @message:
+ * @message: an #LmMessage
*
* Fetches the sub type of @message.
*
--- a/loudmouth/lm-ssl-generic.c Wed Oct 29 17:30:01 2008 +0100
+++ b/loudmouth/lm-ssl-generic.c Wed Oct 29 21:53:19 2008 +0100
@@ -172,6 +172,8 @@
/**
* lm_ssl_use_starttls:
* @ssl: an #LmSSL
+ * @use_starttls: #TRUE if STARTTLS should be used.
+ * @require_starttls: #TRUE if STARTTLS should be required.
*
* Set whether STARTTLS should be used.
**/
@@ -189,8 +191,11 @@
/**
* lm_ssl_get_use_starttls:
+ * @ssl: an #LmSSL
*
- * Return value: TRUE is @ssl is configured to use STARTTLS.
+ * Fetches whether STARTTLS is used.
+ *
+ * Return value: #TRUE is @ssl is configured to use STARTTLS.
**/
gboolean
lm_ssl_get_use_starttls (LmSSL *ssl)
@@ -203,8 +208,11 @@
/**
* lm_ssl_get_require_starttls:
+ * @ssl: an #LmSSL
*
- * Return value: TRUE if @ssl requires that STARTTLS succeed.
+ * Fetches whether STARTTLS is required.
+ *
+ * Return value: #TRUE if @ssl requires that STARTTLS succeed.
**/
gboolean
lm_ssl_get_require_starttls (LmSSL *ssl)
--- a/loudmouth/lm-ssl.h Wed Oct 29 17:30:01 2008 +0100
+++ b/loudmouth/lm-ssl.h Wed Oct 29 21:53:19 2008 +0100
@@ -67,7 +67,7 @@
void lm_ssl_use_starttls (LmSSL *ssl,
gboolean use_starttls,
- gboolean require);
+ gboolean require_starttls);
gboolean lm_ssl_get_use_starttls (LmSSL *ssl);