MixConfigItem: Document which roles are valid to set

src/base/QXmppMixItems.cpp

@@ -544,6 +544,11 @@ QXmppMixConfigItem::Role QXmppMixConfigItem::messagesSubscribeRole() const
 ///
 /// Sets the role that is permitted to subscribe to messages sent through the channel.
 ///
+/// Only the following roles are valid:
+///     * Role::Participant
+///     * Role::Allowed
+///     * Role::Anyone
+///
 /// \param messagesSubscribeRole role permitted to subscribe to the messages
 ///
 void QXmppMixConfigItem::setMessagesSubscribeRole(Role messagesSubscribeRole)
@@ -564,6 +569,11 @@ QXmppMixConfigItem::Role QXmppMixConfigItem::messagesRetractRole() const
 ///
 /// Sets the role that is permitted to retract any message sent through the channel.
 ///
+/// Only the following roles are valid:
+///     * Role::Owner
+///     * Role::Administrator
+///     * Role::Nobody
+///
 /// \param messagesRetractRole role permitted to retract any message
 ///
 void QXmppMixConfigItem::setMessagesRetractRole(Role messagesRetractRole)
@@ -584,6 +594,11 @@ QXmppMixConfigItem::Role QXmppMixConfigItem::presenceSubscribeRole() const
 ///
 /// Sets the role that is permitted to subscribe to the channel's users' presence.
 ///
+/// Only the following roles are valid:
+///     * Role::Participant
+///     * Role::Allowed
+///     * Role::Anyone
+///
 /// \param presenceSubscribeRole role permitted to subscribe to the presence
 ///
 void QXmppMixConfigItem::setPresenceSubscribeRole(Role presenceSubscribeRole)
@@ -624,6 +639,11 @@ QXmppMixConfigItem::Role QXmppMixConfigItem::informationSubscribeRole() const
 ///
 /// Sets the role that is permitted to subscribe to the channel's information.
 ///
+/// Only the following roles are valid:
+///     * Role::Participant
+///     * Role::Allowed
+///     * Role::Anyone
+///
 /// \param informationSubscribeRole role permitted to subscribe to the information
 ///
 void QXmppMixConfigItem::setInformationSubscribeRole(Role informationSubscribeRole)
@@ -644,6 +664,11 @@ QXmppMixConfigItem::Role QXmppMixConfigItem::informationUpdateRole() const
 ///
 /// Sets the role that is permitted to update the channel's information.
 ///
+/// Only the following roles are valid:
+///     * Role::Owner
+///     * Role::Administrator
+///     * Role::Participant
+///
 /// \param informationUpdateRole role permitted to update the information
 ///
 void QXmppMixConfigItem::setInformationUpdateRole(Role informationUpdateRole)
@@ -666,6 +691,13 @@ QXmppMixConfigItem::Role QXmppMixConfigItem::allowedJidsSubscribeRole() const
 /// Sets the role that is permitted to subscribe to the JIDs that are allowed to participate in the
 /// channel.
 ///
+/// Only the following roles are valid:
+///     * Role::Owner
+///     * Role::Administrator
+///     * Role::Participant
+///     * Role::Allowed
+///     * Role::Nobody
+///
 /// \param allowedJidsSubscribeRole role permitted to subscribe to the allowed JIDs
 ///
 void QXmppMixConfigItem::setAllowedJidsSubscribeRole(Role allowedJidsSubscribeRole)
@@ -688,6 +720,13 @@ QXmppMixConfigItem::Role QXmppMixConfigItem::bannedJidsSubscribeRole() const
 /// Sets the role that is permitted to subscribe to the JIDs that are banned from participating in
 /// the channel.
 ///
+/// Only the following roles are valid:
+///     * Role::Owner
+///     * Role::Administrator
+///     * Role::Participant
+///     * Role::Allowed
+///     * Role::Nobody
+///
 /// \param bannedJidsSubscribeRole role permitted to subscribe to the banned JIDs
 ///
 void QXmppMixConfigItem::setBannedJidsSubscribeRole(Role bannedJidsSubscribeRole)
@@ -708,6 +747,13 @@ QXmppMixConfigItem::Role QXmppMixConfigItem::configurationReadRole() const
 ///
 /// Sets the role that is permitted to subscribe to and read the channel's configuration.
 ///
+/// Only the following roles are valid:
+///     * Role::Owner
+///     * Role::Administrator
+///     * Role::Participant
+///     * Role::Allowed
+///     * Role::Nobody
+///
 /// \param configurationReadRole role permitted to subscribe to and read the configuration
 ///
 void QXmppMixConfigItem::setConfigurationReadRole(Role configurationReadRole)
@@ -728,6 +774,11 @@ QXmppMixConfigItem::Role QXmppMixConfigItem::avatarUpdateRole() const
 ///
 /// Sets the role that is permitted to update the channel's avatar.
 ///
+/// Only the following roles are valid:
+///     * Role::Owner
+///     * Role::Administrator
+///     * Role::Participant
+///
 /// \param avatarUpdateRole role permitted to update the avatar
 ///
 void QXmppMixConfigItem::setAvatarUpdateRole(Role avatarUpdateRole)