Swiftdiff options
| author | Tobias Markmann <tm@ayena.de> | 2016-12-08 09:22:52 (GMT) |
|---|---|---|
| committer | Edwin Mons <edwin.mons@isode.com> | 2016-12-09 08:30:45 (GMT) |
| commit | 7b34ce22fd646c252791a3eda5005178ab3f19bf (patch) | |
| tree | 79f99ecd31e90d37a2179e0b026eaf691cac0deb /Swift/Controllers/UIEvents | |
| parent | da7162b6e80ed6ce802bece3891fe85f30770c56 (diff) | |
| download | swift-7b34ce22fd646c252791a3eda5005178ab3f19bf.zip swift-7b34ce22fd646c252791a3eda5005178ab3f19bf.tar.bz2 | |
Improve documentation of code related to impromptu chats
Test-Information:
Builds and all tests pass on macOS 10.12.1.
Change-Id: I58ca7ba27736d27426350f636dfe910f4f2f1b17
Diffstat (limited to 'Swift/Controllers/UIEvents')
| -rw-r--r-- | Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h b/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h index 22ce926..e420bad 100644 --- a/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h +++ b/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h @@ -23,11 +23,21 @@ namespace Swift { class CreateImpromptuMUCUIEvent : public UIEvent { public: + /** + * @brief CreateImpromptuMUCUIEvent + * @param jids A vector of JIDs that are invited to the imprompto MUC. + * Useful when the event is used to recreate an old impromptu + * chat room. + * @param roomJID The full JID of the impromtu MUC. Useful when the event + * is used to recreate an old impromptu chat room. + * @param reason + */ CreateImpromptuMUCUIEvent(const std::vector<JID>& jids, const JID& roomJID = JID(), const std::string reason = "") : jids_(jids), roomJID_(roomJID), reason_(reason) { } std::vector<JID> getJIDs() const { return jids_; } JID getRoomJID() const { return roomJID_; } std::string getReason() const { return reason_; } + private: std::vector<JID> jids_; JID roomJID_; |