diff options
| author | Lance Stout <lancestout@gmail.com> | 2011-12-04 16:26:14 -0800 |
|---|---|---|
| committer | Lance Stout <lancestout@gmail.com> | 2011-12-04 16:26:14 -0800 |
| commit | 2586fdffda9dac5ee56664c74e71bd54ae47ee18 (patch) | |
| tree | 8c3eff0ed8ed6539b7eace355a90e8ede9634d0a /docs | |
| parent | c9dc9ec11e8ef141234d8376fe8882ae13babbf8 (diff) | |
| download | slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.tar.gz slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.tar.bz2 slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.tar.xz slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.zip | |
Update api docs for handlers and matchers
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/xmlstream/handler.rst | 24 | ||||
| -rw-r--r-- | docs/api/xmlstream/jid.rst (renamed from docs/api/jid.rst) | 0 | ||||
| -rw-r--r-- | docs/api/xmlstream/matcher.rst | 41 | ||||
| -rw-r--r-- | docs/index.rst | 4 |
4 files changed, 68 insertions, 1 deletions
diff --git a/docs/api/xmlstream/handler.rst b/docs/api/xmlstream/handler.rst new file mode 100644 index 00000000..33c0bf42 --- /dev/null +++ b/docs/api/xmlstream/handler.rst @@ -0,0 +1,24 @@ +Stanza Handlers +=============== + +The Basic Handler +----------------- +.. module:: sleekxmpp.xmlstream.handler.base + +.. autoclass:: BaseHandler + :members: + +Callback +-------- +.. module:: sleekxmpp.xmlstream.handler.callback + +.. autoclass:: Callback + :members: + + +Waiter +------ +.. module:: sleekxmpp.xmlstream.handler.waiter + +.. autoclass:: Waiter + :members: diff --git a/docs/api/jid.rst b/docs/api/xmlstream/jid.rst index 22a2db45..22a2db45 100644 --- a/docs/api/jid.rst +++ b/docs/api/xmlstream/jid.rst diff --git a/docs/api/xmlstream/matcher.rst b/docs/api/xmlstream/matcher.rst new file mode 100644 index 00000000..df3591bc --- /dev/null +++ b/docs/api/xmlstream/matcher.rst @@ -0,0 +1,41 @@ +Stanza Matchers +=============== + +The Basic Matcher +----------------- +.. module:: sleekxmpp.xmlstream.matcher.base + +.. autoclass:: MatcherBase + :members: + + +ID Matching +----------- +.. module:: sleekxmpp.xmlstream.matcher.id + +.. autoclass:: MatcherId + :members: + + +Stanza Path Matching +-------------------- +.. module:: sleekxmpp.xmlstream.matcher.stanzapath + +.. autoclass:: StanzaPath + :members: + + +XPath +----- +.. module:: sleekxmpp.xmlstream.matcher.xpath + +.. autoclass:: MatchXPath + :members: + + +XMLMask +------- +.. module:: sleekxmpp.xmlstream.matcher.xmlmask + +.. autoclass:: MatchXMLMask + :members: diff --git a/docs/index.rst b/docs/index.rst index 76c3741e..5d2577d2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -112,8 +112,10 @@ API Reference api/clientxmpp api/componentxmpp api/basexmpp - api/jid + api/xmlstream/jid api/xmlstream/stanzabase + api/xmlstream/handler + api/xmlstream/matcher api/xmlstream/tostring api/xmlstream/filesocket |