1 files changed, 8 insertions, 0 deletions
diff --git a/Swift/Controllers/Roster/ContactRosterItem.h b/Swift/Controllers/Roster/ContactRosterItem.h
index 37c3840..9779859 100644
--- a/Swift/Controllers/Roster/ContactRosterItem.h
+++ b/Swift/Controllers/Roster/ContactRosterItem.h
@@ -16,60 +16,68 @@
 #include <boost/filesystem/path.hpp>
 #include <boost/signals2.hpp>
 
 #include <Swiften/Elements/MUCOccupant.h>
 #include <Swiften/Elements/StatusShow.h>
 #include <Swiften/Elements/VCard.h>
 #include <Swiften/JID/JID.h>
 
 #include <Swift/Controllers/Roster/RosterItem.h>
 
 namespace Swift {
 
 class GroupRosterItem;
 class Presence;
 
 class ContactRosterItem : public RosterItem {
     public:
         enum Feature {
             FileTransferFeature,
             WhiteboardFeature
         };
 
         enum BlockState {
             BlockingNotSupported,
             IsBlocked,
             IsUnblocked,
             IsDomainBlocked
         };
 
     public:
+        /**
+        * @brief ContactRosterItem contains the information of a contact that is part of a XMPP Roster.
+        * @param jid The JabberID of the contact in the Roster entry.
+        * @param displayJID An alternate JID that is used instead of the JID this item represents. If not available, 
+        * an empty node should be passed. This parameter will be converted to a bare JID.
+        * @param name The name or nickname of the contact
+        * @param parent The roster group that the contact is a member of. The same JID may be in several roster groups, in which case they will have individual ContactRosterItems with the same JID.
+        */
         ContactRosterItem(const JID& jid, const JID& displayJID, const std::string& name, GroupRosterItem* parent);
         virtual ~ContactRosterItem();
 
         StatusShow::Type getStatusShow() const;
         StatusShow::Type getSimplifiedStatusShow() const;
         std::string getStatusText() const;
         std::string getIdleText() const;
         boost::posix_time::ptime getIdle() const;
         std::string getOfflineSinceText() const;
         boost::posix_time::ptime getOfflineSince() const;
         void setAvatarPath(const boost::filesystem::path& path);
         const boost::filesystem::path& getAvatarPath() const;
         const JID& getJID() const;
         void setDisplayJID(const JID& jid);
         const JID& getDisplayJID() const;
         void applyPresence(std::shared_ptr<Presence> presence);
         const std::vector<std::string>& getGroups() const;
         /** Only used so a contact can know about the groups it's in*/
         void addGroup(const std::string& group);
         void removeGroup(const std::string& group);
         void clearPresence();
 
         MUCOccupant::Role getMUCRole() const;
         void setMUCRole(const MUCOccupant::Role& role);
         MUCOccupant::Affiliation getMUCAffiliation() const;
         void setMUCAffiliation(const MUCOccupant::Affiliation& affiliation);
         std::string getMUCAffiliationText() const;
 
         void setSupportedFeatures(const std::set<Feature>& features);
         bool supportsFeature(Feature feature) const;