[telepathy-gabble/master] gabble_decode_jid(): update documentation

[Dafydd Harries]

---
 src/util.c |   14 +++++---------
 1 files changed, 5 insertions(+), 9 deletions(-)

diff --git a/src/util.c b/src/util.c
index 9d8135c..1a7d699 100644
--- a/src/util.c
+++ b/src/util.c
@@ -416,15 +416,11 @@ lm_message_build_with_sub_type (const gchar *to, LmMessageType type,
  *  node at domain
  *  node at domain/resource
  *
- * Sets the caller's node, domain and resource pointers to the node, domain
- * and resource parts respectively, if available in the provided JID. The
- * caller may set any of the pointers to NULL if they are not interested in a
- * certain component.
- *
- * The returned values may be NULL or zero-length if a component was either
- * not present or zero-length respectively in the given JID. The node and
- * domain are lower-cased because the Jabber protocol treats them
- * case-insensitively.
+ * If the JID is valid, returns TRUE and sets the caller's
+ * node/domain/resource pointers if they are not NULL. The node and resource
+ * pointers will be set to NULL if the respective part is not present in the
+ * JID. The node and domain are lower-cased because the Jabber protocol treats
+ * them case-insensitively.
  */
 gboolean
 gabble_decode_jid (const gchar *jid,
-- 
1.5.6.5