Add docs to IrcUser::updateNickFromMask

(cherry picked from commit a0bcb6393bc23734c9df0283a3ddbe4ec63c2f11)

diff --git a/src/common/network.h b/src/common/network.h
index e425701..55e953a 100644 (file)
--- 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