From: Shane Synan <digitalcircuit36939@gmail.com>
Date: Fri, 27 May 2016 04:39:43 +0000 (-0400)
Subject: Add docs to IrcUser::updateNickFromMask
X-Git-Tag: travis-deploy-test~470^2~7
X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=commitdiff_plain;h=a0bcb6393bc23734c9df0283a3ddbe4ec63c2f11;hp=b163ae76ce6d064942854e1415a4ee0e495adec8;ds=sidebyside

Add docs to IrcUser::updateNickFromMask
---

diff --git a/src/common/network.h b/src/common/network.h
index 3e58fdac..f6e7de1f 100644
--- a/src/common/network.h
+++ b/src/common/network.h
@@ -269,6 +269,12 @@ public slots:
     inline void initSetServerList(const QVariantList &serverList) { _serverList = fromVariantList<Server>(serverList); }
     virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
 
+    /**
+     * Update IrcUser hostmask and username from mask, creating an IrcUser if one does not exist.
+     *
+     * @param[in] mask   Full nick!user@hostmask string
+     * @return IrcUser of the matching nick if exists, otherwise a new IrcUser
+     */
     IrcUser *updateNickFromMask(const QString &mask);
 
     // these slots are to keep the hashlists of all users and the