diff options
| author | Zeyla Hellyer <[email protected]> | 2017-03-25 16:58:47 -0700 |
|---|---|---|
| committer | Zeyla Hellyer <[email protected]> | 2017-03-25 16:58:47 -0700 |
| commit | 21837b345046a9eb450bf51b505c0910a2b10ab0 (patch) | |
| tree | 25dd982998d7adef70fa8cc36f4ec6b250f19851 /src/ext/framework | |
| parent | Fix tests (diff) | |
| download | serenity-21837b345046a9eb450bf51b505c0910a2b10ab0.tar.xz serenity-21837b345046a9eb450bf51b505c0910a2b10ab0.zip | |
Improve some framework docs
Diffstat (limited to 'src/ext/framework')
| -rw-r--r-- | src/ext/framework/configuration.rs | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/src/ext/framework/configuration.rs b/src/ext/framework/configuration.rs index 5448a25..0fd18c2 100644 --- a/src/ext/framework/configuration.rs +++ b/src/ext/framework/configuration.rs @@ -4,16 +4,27 @@ use super::command::PrefixCheck; use ::client::{Context, rest}; use ::model::{GuildId, UserId}; -/// Account type used for configuration. +/// The account type used when setting the framework [`Configuration`]. +/// +/// [`Configuration`]: struct.Configuration.html pub enum AccountType { - /// Connected client will only listen to itself. + /// The current user will only react to [`Message`]s sent by itself. + /// + /// [`Message`]: ../../model/struct.Message.html Selfbot, - /// Connected client will ignore all bot accounts. + /// The current user will only react to [`Message`]s sent by [`User`]s which + /// are _not_ [bot][`User::bot`]s. + /// + /// [`Message`]: ../../model/struct.Message.html + /// [`User`]: ../../model/struct.User.html + /// [`User::bot`]: ../../model/struct.User.html#structfield.bot Bot, - /// Connected client will listen to everyone. + /// The current user will react to all [`Message`]s. + /// + /// [`Message`]: ../../model/struct.Message.html Any, #[doc(hidden)] - Automatic + Automatic, } /// The configuration to use for a [`Framework`] associated with a [`Client`] |