summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWill Thompson <will.thompson@collabora.co.uk>2013-02-13 18:43:15 +0000
committerWill Thompson <will.thompson@collabora.co.uk>2013-02-13 18:47:09 +0000
commit57085645d2c21c042961ed79fc02408e9d5f4c3b (patch)
treece132fb91315650c043bfe8e2f54b26cb7efa6a3
parent795a6501309814bc3a8476975bb2baf9bc86a4fa (diff)
Fix reference to wocky_porter_register_handler()
This was renamed to wocky_porter_register_handler_from(), but its documentation was not updated. Also, the arguments to the function were wrong: there was a NULL where the JID should be, and the JID appeared later in the wrong place. While we're here, fix some formatting earlier on in the same comment. I think using &commat; rather than the <!-- --> trick is more legible.
-rw-r--r--wocky/wocky-porter.c15
1 files changed, 9 insertions, 6 deletions
diff --git a/wocky/wocky-porter.c b/wocky/wocky-porter.c
index 5b19567..4161fe2 100644
--- a/wocky/wocky-porter.c
+++ b/wocky/wocky-porter.c
@@ -465,18 +465,21 @@ wocky_porter_register_handler_from_by_stanza (WockyPorter *self,
*
* If @from is a bare JID, then the resource of the JID in the from attribute
* will be ignored: In other words, a handler registered against a bare JID
- * will match _all_ stanzas from a JID with the same node and domain:
- * "foo@<!-- -->bar.org" will match
- * "foo@<!-- -->bar.org", "foo@<!-- -->bar.org/moose" and so forth.
+ * will match <emphasis>all</emphasis> stanzas from a JID with the same node
+ * and domain:
+ * <code>"foo&commat;bar.org"</code> will match
+ * <code>"foo&commat;bar.org"</code>,
+ * <code>"foo&commat;bar.org/moose"</code> and so forth.
*
* To register an IQ handler from Juliet for all the Jingle stanzas related
* to one Jingle session:
*
* |[
- * id = wocky_porter_register_handler (porter,
- * WOCKY_STANZA_TYPE_IQ, WOCKY_STANZA_SUB_TYPE_NONE, NULL,
- * WOCKY_PORTER_HANDLER_PRIORITY_NORMAL, jingle_cb,
+ * id = wocky_porter_register_handler_from (porter,
+ * WOCKY_STANZA_TYPE_IQ, WOCKY_STANZA_SUB_TYPE_NONE,
* "juliet@example.com/Balcony",
+ * WOCKY_PORTER_HANDLER_PRIORITY_NORMAL,
+ * jingle_cb,
* '(', "jingle",
* ':', "urn:xmpp:jingle:1",
* '@', "sid", "my_sid",