summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRemko Tronçon <git@el-tramo.be>2010-10-24 17:37:19 (GMT)
committerRemko Tronçon <git@el-tramo.be>2010-10-24 17:46:39 (GMT)
commitfdcbeaf726457823892d86dd4b95db6f50ea3f5c (patch)
tree2bc71acdb01273966fd34d6e98a7bbc81cc08ad9
parent2d3c5ce054a27548e72638c02c9bf3c8cec2faba (diff)
downloadswift-contrib-fdcbeaf726457823892d86dd4b95db6f50ea3f5c.zip
swift-contrib-fdcbeaf726457823892d86dd4b95db6f50ea3f5c.tar.bz2
Added some doxygen docs.
-rw-r--r--Swiften/Client/Client.h1
-rw-r--r--Swiften/Disco/EntityCapsManager.h12
2 files changed, 13 insertions, 0 deletions
diff --git a/Swiften/Client/Client.h b/Swiften/Client/Client.h
index 342fe76..c2c9c60 100644
--- a/Swiften/Client/Client.h
+++ b/Swiften/Client/Client.h
@@ -97,6 +97,7 @@ namespace Swift {
AvatarManager* getAvatarManager() const {
return avatarManager;
}
+
EntityCapsManager* getEntityCapsManager() const {
return entityCapsManager;
}
diff --git a/Swiften/Disco/EntityCapsManager.h b/Swiften/Disco/EntityCapsManager.h
index 810e260..01f8793 100644
--- a/Swiften/Disco/EntityCapsManager.h
+++ b/Swiften/Disco/EntityCapsManager.h
@@ -15,12 +15,24 @@ namespace Swift {
class StanzaChannel;
class CapsProvider;
+ /**
+ * This class is responsible for gathering and providing
+ * information about capabilities of entities on the network.
+ * This information is provided in the form of service discovery
+ * information.
+ */
class EntityCapsManager : public boost::bsignals::trackable {
public:
EntityCapsManager(CapsProvider*, StanzaChannel*);
+ /**
+ * Returns the service discovery information of the given JID.
+ */
DiscoInfo::ref getCaps(const JID&) const;
+ /**
+ * Emitted when the capabilities of a JID changes.
+ */
boost::signal<void (const JID&)> onCapsChanged;
private: