2003-11-20 Ross Burton <ross@burtonini.com>
* loudmouth/lm-message-node.h:
- Mark the private members how gtk-doc wants it.
* loudmouth/lm-message-node.c:
- Fix comment typos and document more parameters.
* loudmouth/lm-connection.c: Fix comment typos.
* docs/reference/loudmouth-sections.txt:
- Removed a non-existent function.
* docs/reference/tmpl/lm-connection.sgml: Fix some typos.
* docs/reference/tmpl/lm-message-node.sgml:
- Document raw_node, and remove private fields.
* docs/reference/tmpl/lm-message.sgml: gtk-doc did this itself...
--- a/ChangeLog Sat Nov 15 23:01:08 2003 +0000
+++ b/ChangeLog Thu Nov 27 21:12:51 2003 +0000
@@ -1,3 +1,23 @@
+2003-11-20 Ross Burton <ross@burtonini.com>
+
+ * loudmouth/lm-message-node.h:
+ - Mark the private members how gtk-doc wants it.
+
+ * loudmouth/lm-message-node.c:
+ - Fix comment typos and document more parameters.
+
+ * loudmouth/lm-connection.c: Fix comment typos.
+
+ * docs/reference/loudmouth-sections.txt:
+ - Removed a non-existent function.
+
+ * docs/reference/tmpl/lm-connection.sgml: Fix some typos.
+
+ * docs/reference/tmpl/lm-message-node.sgml:
+ - Document raw_node, and remove private fields.
+
+ * docs/reference/tmpl/lm-message.sgml: gtk-doc did this itself...
+
2003-11-16 Mikael Hallendal <micke@imendio.com>
* loudmouth/lm-connection.c:
--- a/acinclude.m4 Sat Nov 15 23:01:08 2003 +0000
+++ b/acinclude.m4 Thu Nov 27 21:12:51 2003 +0000
@@ -27,7 +27,7 @@
maximum|error)
warning_flags="-Wall -Wunused -Wchar-subscripts -Wmissing-declarations -Wmissing-prototypes -Wnested-externs -Wpointer-arith"
CFLAGS="$warning_flags $CFLAGS"
- for option in -Wsign-promo -Wno-sign-compare; do
+ for option in -Wno-sign-compare; do
SAVE_CFLAGS="$CFLAGS"
CFLAGS="$CFLAGS $option"
AC_MSG_CHECKING([whether gcc understands $option])
--- a/docs/reference/loudmouth-sections.txt Sat Nov 15 23:01:08 2003 +0000
+++ b/docs/reference/loudmouth-sections.txt Thu Nov 27 21:12:51 2003 +0000
@@ -16,7 +16,6 @@
lm_connection_authenticate
lm_connection_authenticate_and_block
lm_connection_is_open
-lm_connection_is_connected
lm_connection_is_authenticated
lm_connection_get_server
lm_connection_set_server
--- a/docs/reference/tmpl/lm-connection.sgml Sat Nov 15 23:01:08 2003 +0000
+++ b/docs/reference/tmpl/lm-connection.sgml Thu Nov 27 21:12:51 2003 +0000
@@ -52,7 +52,7 @@
<!-- ##### ENUM LmHandlerPriority ##### -->
<para>
-Since the handlers decide whether to stop the calling chain with there return values it's sometimes decirable to be able to set priority. For example a handler that only logs all incoming messages and then pass the message on to another handler wants to have priority %LM_HANDLER_PRIORITY_FIRST. An handler that should take all messages that wasn't handled by anything else would want to have priority %LM_HANDLER_PRIORITY_LAST. If several handlers have the same priority nothing can be side about which handler will be called first of them.
+Since the handlers decide whether to stop the calling chain with there return values it's sometimes decirable to be able to set priority. For example a handler that only logs all incoming messages and then pass the message on to another handler wants to have priority %LM_HANDLER_PRIORITY_FIRST. An handler that should take all messages that wasn't handled by anything else would want to have priority %LM_HANDLER_PRIORITY_LAST. If several handlers have the same priority nothing can be said about the order the handlers will be called in.
</para>
@LM_HANDLER_PRIORITY_LAST: Call the handler after all handlers with #NORMAL and #FIRST priority.
@@ -65,7 +65,7 @@
</para>
@LM_DISCONNECT_REASON_OK:
-@LM_DISCONNECT_REASON_PING_TIME_OUT: Connection to the server pinged out.
+@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_UNKNOWN: An unknown error.
--- a/docs/reference/tmpl/lm-message-node.sgml Sat Nov 15 23:01:08 2003 +0000
+++ b/docs/reference/tmpl/lm-message-node.sgml Thu Nov 27 21:12:51 2003 +0000
@@ -21,13 +21,11 @@
@name: the name of the node
@value: value of the node, can be NULL
-@raw_mode:
+@raw_mode: if true, don't escape the content of the message. The content must be valid XML.
@next: next sibling
@prev: previous sibling
@parent: node parent
@children: pointing to first child
-@attributes: list of attributes. This shouldn't be accessed directly.
-@ref_count: Reference count of node, internal value.
<!-- ##### FUNCTION lm_message_node_get_value ##### -->
<para>
@@ -93,9 +91,11 @@
</para>
-@message_node:
+@node:
@child_name:
@Returns:
+<!-- # Unused Parameters # -->
+@message_node:
<!-- ##### FUNCTION lm_message_node_find_child ##### -->
@@ -103,9 +103,11 @@
</para>
-@message_node:
+@node:
@child_name:
@Returns:
+<!-- # Unused Parameters # -->
+@message_node:
<!-- ##### FUNCTION lm_message_node_get_raw_mode ##### -->
--- a/loudmouth/lm-connection.c Sat Nov 15 23:01:08 2003 +0000
+++ b/loudmouth/lm-connection.c Thu Nov 27 21:12:51 2003 +0000
@@ -907,7 +907,7 @@
* @notify: Function for freeing that user_data, can be NULL.
* @error: location to store error, or %NULL
*
- * An async call to open @connection. When the connection is open @function will be called.
+ * An asynchronous call to open @connection. When the connection is open @function will be called.
*
* Return value: #TRUE if everything went fine, otherwise #FALSE.
**/
@@ -1055,7 +1055,7 @@
* @connection: #LmConnection to close
* @error: location to store error, or %NULL
*
- * A synchronos call to close the connection. When returning the connection is considered to be closed and can be opened again with lm_connection_open().
+ * A synchronous call to close the connection. When returning the connection is considered to be closed and can be opened again with lm_connection_open().
*
* Return value: Returns #TRUE if no errors where detected, otherwise #FALSE.
**/
@@ -1100,7 +1100,7 @@
* @notify: Destroy function to free the memory used by @user_data, can be NULL.
* @error: location to store error, or %NULL
*
- * Tries to authenticate a user against the server. The #LmResult in the result callback will tell if it succeeded or not.
+ * Tries to authenticate a user against the server. The #LmResult in the result callback @function will say whether it succeeded or not.
*
* Return value: #TRUE if no errors where detected while sending the authentication message, #FALSE otherwise.
**/
@@ -1279,7 +1279,7 @@
* @connection: an #LmConnection
* @server: Address of the server
*
- * Sets the server address to @connection. Notice that @connection can't be open while doing this.
+ * Sets the server address for @connection to @server. Notice that @connection can't be open while doing this.
**/
void
lm_connection_set_server (LmConnection *connection, const gchar *server)
@@ -1300,7 +1300,7 @@
* lm_connection_get_port:
* @connection: an #LmConnection
*
- * Fetches the port tnat @connection is using.
+ * Fetches the port that @connection is using.
*
* Return value:
**/
@@ -1315,7 +1315,7 @@
* @connection: an #LmConnection
* @port: server port
*
- * Sets the server port of that @connection will be using.
+ * Sets the server port that @connection will be using.
**/
void
lm_connection_set_port (LmConnection *connection, guint port)
@@ -1331,9 +1331,9 @@
/**
* lm_connection_supports_ssl:
*
- * Checks whether Loudmouth supports SSL or not
+ * Checks whether Loudmouth supports SSL or not.
*
- * Return value: #TRUE if this installation of Loudmouth supports SSL, otherwise returnes #FALSE.
+ * Return value: #TRUE if this installation of Loudmouth supports SSL, otherwise returns #FALSE.
**/
gboolean
lm_connection_supports_ssl (void)
@@ -1349,7 +1349,7 @@
* lm_connection_get_use_ssl:
* @connection: an #LmConnection
*
- * Fetches if @connection is using SSL or not
+ * Returns if @connection is using SSL or not
*
* Return value: #TRUE if @connection is using SSL, #FALSE otherwise.
**/
@@ -1364,7 +1364,7 @@
* @connection: an #LmConnection
* @use_ssl: whether to use SSL or not.
*
- * Sets whether @connection should use SSL for encryping traffic to/from the server.
+ * Sets whether @connection should use SSL for encrypting traffic to/from the server.
**/
void
lm_connection_set_use_ssl (LmConnection *connection, gboolean use_ssl)
@@ -1379,7 +1379,7 @@
/**
* lm_connection_send:
- * @connection: #LmConnection to send connection over.
+ * @connection: #LmConnection to send message over.
* @message: #LmMessage to send.
* @error: location to store error, or %NULL
*
@@ -1419,7 +1419,7 @@
*
* Send a #LmMessage which will result in a reply.
*
- * Return value:
+ * Return value: Returns #TRUE if no errors where detected while sending, #FALSE otherwise.
**/
gboolean
lm_connection_send_with_reply (LmConnection *connection,
@@ -1649,7 +1649,7 @@
* @connection: Connection to remove reference from.
*
* Removes a reference on @connection. If there are no references to
- * @connection it will be fried and shouldn't be used again.
+ * @connection it will be freed and shouldn't be used again.
**/
void
lm_connection_unref (LmConnection *connection)
--- a/loudmouth/lm-message-node.c Sat Nov 15 23:01:08 2003 +0000
+++ b/loudmouth/lm-message-node.c Thu Nov 27 21:12:51 2003 +0000
@@ -191,6 +191,7 @@
* lm_message_node_set_attributes:
* @node: an #LmMessageNode
* @name: the first attribute, should be followed by a string with the value
+ * @Varargs: The rest of the name/value pairs
*
* Sets a list of attributes. The arguments should be names and corresponding
* value and needs to be ended with %NULL.
@@ -310,8 +311,8 @@
/**
* lm_message_node_find_child:
- * @node:
- * @child_name:
+ * @node: A #LmMessageNode
+ * @child_name: The name of the child to find
*
* Locates a child among all children of @node. The entire tree will be search
* until a child with name @child_name is located.
--- a/loudmouth/lm-message-node.h Sat Nov 15 23:01:08 2003 +0000
+++ b/loudmouth/lm-message-node.h Thu Nov 27 21:12:51 2003 +0000
@@ -40,7 +40,7 @@
LmMessageNode *parent;
LmMessageNode *children;
- /* Private */
+ /* < private > */
GSList *attributes;
gint ref_count;
};
@@ -59,9 +59,9 @@
const gchar *value);
const gchar * lm_message_node_get_attribute (LmMessageNode *node,
const gchar *name);
-LmMessageNode *lm_message_node_get_child (LmMessageNode *message_node,
+LmMessageNode *lm_message_node_get_child (LmMessageNode *node,
const gchar *child_name);
-LmMessageNode *lm_message_node_find_child (LmMessageNode *message_node,
+LmMessageNode *lm_message_node_find_child (LmMessageNode *node,
const gchar *child_name);
gboolean lm_message_node_get_raw_mode (LmMessageNode *node);
void lm_message_node_set_raw_mode (LmMessageNode *node,