diff options
| author | Zeyla Hellyer <[email protected]> | 2017-03-25 15:35:50 -0700 |
|---|---|---|
| committer | Zeyla Hellyer <[email protected]> | 2017-03-25 15:35:50 -0700 |
| commit | 356c9c0d42f4b0583a2c7b5333196c4f4e6a73cc (patch) | |
| tree | fe4296b5c07b32be2c3a7d1f2169fe3f00c1a415 /src/model/mod.rs | |
| parent | Fix Member methods due to variant joined_at values (diff) | |
| download | serenity-356c9c0d42f4b0583a2c7b5333196c4f4e6a73cc.tar.xz serenity-356c9c0d42f4b0583a2c7b5333196c4f4e6a73cc.zip | |
Add slightly more documentation
Diffstat (limited to 'src/model/mod.rs')
| -rw-r--r-- | src/model/mod.rs | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/model/mod.rs b/src/model/mod.rs index c3dd233..c871f90 100644 --- a/src/model/mod.rs +++ b/src/model/mod.rs @@ -173,9 +173,24 @@ pub enum PossibleGuild<T> { Online(T), } +/// Denotes the target for a search. +/// +/// This can be either a [`Guild`] - which can search multiple [`Channel`]s - +/// or a `Channel`. +/// +/// [`Channel`]: enum.Channel.html +/// [`Guild`]: struct.Guild.html #[derive(Copy, Clone, Debug)] pub enum SearchTarget { + /// An indicator that the target for a [`Search`] is a [`Channel`]. + /// + /// [`Channel`]: enum.Channel.html + /// [`Search`]: struct.Search.html Channel(ChannelId), + /// An indicator that the target for a [`Search`] is a [`Guild`]. + /// + /// [`Guild`]: struct.Guild.html + /// [`Search`]: struct.Search.html Guild(GuildId), } |