diff options
| author | Jeremy Lainé <jeremy.laine@m4x.org> | 2014-08-21 11:26:03 +0200 |
|---|---|---|
| committer | Jeremy Lainé <jeremy.laine@m4x.org> | 2014-08-21 11:26:03 +0200 |
| commit | d8d2a1f13eaca2f73f92a9a3da20df3acf44e9c1 (patch) | |
| tree | 953f9706501ff4dcbe4e0311a369854feb24f77b | |
| parent | 4b53eea047641cb77c542e4ce3292f2dcdd39522 (diff) | |
| download | qxmpp-d8d2a1f13eaca2f73f92a9a3da20df3acf44e9c1.tar.gz | |
add list of XEPs to documentation
| -rw-r--r-- | doc/doxyfilter.cpp | 2 | ||||
| -rw-r--r-- | doc/index.doc | 77 | ||||
| -rw-r--r-- | doc/xep.doc | 44 |
3 files changed, 82 insertions, 41 deletions
diff --git a/doc/doxyfilter.cpp b/doc/doxyfilter.cpp index 854f2332..da9adbed 100644 --- a/doc/doxyfilter.cpp +++ b/doc/doxyfilter.cpp @@ -75,7 +75,7 @@ int main(int argc, char *argv[]) setField(code, "HIDE_UNDOC_CLASSES", "YES"); setField(code, "GENERATE_LATEX", "NO"); setField(code, "HTML_TIMESTAMP", "NO"); - setField(code, "INPUT", "index.doc ../src"); + setField(code, "INPUT", "index.doc xep.doc ../src"); setField(code, "INPUT_FILTER", QString::fromLocal8Bit(argv[0])); setField(code, "PROJECT_NAME", "QXmpp"); setField(code, "PROJECT_NUMBER", QString("Version: %1.%2.%3").arg( diff --git a/doc/index.doc b/doc/index.doc index 19941e6c..1652fe18 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -1,41 +1,38 @@ -/*! - \mainpage - - QXmpp is a cross-platform C++ XMPP client library based on the Qt - framework. It tries to use Qt's programming conventions in order to ease - the learning curve for new programmers. - - QXmpp based clients are built using QXmppClient instances which handle the - establishment of the XMPP connection and provide a number of high-level - "managers" to perform specific tasks. You can write your own managers to - extend QXmpp by subclassing QXmppClientExtension. - - <B>Main Class:</B> - - QXmppClient - - <B>Managers to perform specific tasks:</B> - - QXmppRosterManager - - QXmppVCardManager - - QXmppTransferManager - - QXmppMucManager - - QXmppCallManager - - QXmppArchiveManager - - QXmppVersionManager - - QXmppDiscoveryManager - - QXmppEntityTimeManager - - <B>XMPP stanzas:</B> If you are interested in a more low-level API, you can refer to these - classes. - - QXmppIq - - QXmppMessage - - QXmppPresence - - <BR><BR> - <B>Project Details:</B> - - Project Page: https://github.com/qxmpp-project/qxmpp/ - <BR> - Report Issues: https://github.com/qxmpp-project/qxmpp/issues/ - <BR> - New Releases: https://github.com/qxmpp-project/qxmpp/downloads/ +/*! \mainpage + +QXmpp is a cross-platform C++ XMPP client library based on the Qt +framework. It tries to use Qt's programming conventions in order to ease +the learning curve for new programmers. + +QXmpp based clients are built using QXmppClient instances which handle the +establishment of the XMPP connection and provide a number of high-level +"managers" to perform specific tasks. You can write your own managers to +extend QXmpp by subclassing QXmppClientExtension. + +<B>Main Class:</B> +- QXmppClient + +<B>Managers to perform specific tasks:</B> +- QXmppRosterManager +- QXmppVCardManager +- QXmppTransferManager +- QXmppMucManager +- QXmppCallManager +- QXmppArchiveManager +- QXmppVersionManager +- QXmppDiscoveryManager +- QXmppEntityTimeManager + +<B>XMPP stanzas:</B> If you are interested in a more low-level API, you can refer to these +classes. +- QXmppIq +- QXmppMessage +- QXmppPresence + +<B>Project Details:</B> + +- Project Page: https://github.com/qxmpp-project/qxmpp/ +- Report Issues: https://github.com/qxmpp-project/qxmpp/issues/ +- New Releases: https://github.com/qxmpp-project/qxmpp/downloads/ + */ diff --git a/doc/xep.doc b/doc/xep.doc new file mode 100644 index 00000000..9c356c32 --- /dev/null +++ b/doc/xep.doc @@ -0,0 +1,44 @@ +/*! \page xep XMPP Extensions + +This document lists the XMPP Extensions (XEP) available in QXmpp. + +Complete: +- XEP-0004: Data Forms +- XEP-0030: Service Discovery +- XEP-0033: Extended Stanza Addressing +- XEP-0045: Multi-User Chat +- XEP-0047: In-Band Bytestreams +- XEP-0048: Bookmarks +- XEP-0054: vcard-temp +- XEP-0059: Result Set Management +- XEP-0065: SOCKS5 Bytestreams +- XEP-0071: XHTML-IM +- XEP-0078: Non-SASL Authentication +- XEP-0082: XMPP Date and Time Profiles +- XEP-0085: Chat State Notifications +- XEP-0091: Legacy Delayed Delivery +- XEP-0092: Software Version +- XEP-0095: Stream Initiation +- XEP-0096: SI File Transfer +- XEP-0115: Entity Capabilities +- XEP-0128: Service Discovery Extensions +- XEP-0136: Message Archiving +- XEP-0153: vCard-Based Avatars +- XEP-0166: Jingle +- XEP-0167: Jingle RTP Sessions +- XEP-0176: Jingle ICE-UDP Transport Method +- XEP-0184: Message Delivery Receipts +- XEP-0199: XMPP Ping +- XEP-0202: Entity Time +- XEP-0203: Delayed Delivery +- XEP-0221: Data Forms Media Element +- XEP-0224: Attention + +Ongoing: +- XEP-0009: Jabber-RPC + +TODO: +- XEP-0060: Publish-Subscribe +- XEP-0077: In-Band Registration + +*/ |
