Add documentation to isStatusMsg

[quassel.git] / src / common / network.h

diff --git a/src/common/network.h b/src/common/network.h
index c6f8f67..e425701 100644 (file)
--- a/src/common/network.h
+++ b/src/common/network.h
@@ -131,6 +131,17 @@ public :
     inline bool isMe(IrcUser *ircuser) const { return (ircuser->nick().toLower() == myNick().toLower()); }
 
     bool isChannelName(const QString &channelname) const;
+
+    /**
+     * Checks if the target counts as a STATUSMSG
+     *
+     * Status messages are prefixed with one or more characters from the server-provided STATUSMSG
+     * if available, otherwise "@" and "+" are assumed.  Generally, status messages sent to a
+     * channel are only visible to those with the same or higher permissions, e.g. voiced.
+     *
+     * @param[in] target Name of destination, e.g. a channel or query
+     * @returns True if a STATUSMSG, otherwise false
+     */
     bool isStatusMsg(const QString &target) const;
 
     inline bool isConnected() const { return _connected; }