aboutsummaryrefslogtreecommitdiff
path: root/src/model
diff options
context:
space:
mode:
authorfwrs <[email protected]>2016-11-27 22:01:36 +0000
committerAustin Hellyer <[email protected]>2016-11-27 15:59:31 -0800
commit9061c2d859ab4cac27c44f17b1f6d2bb6060b520 (patch)
treeb0762a836d440e572e67d2ba4c626473c5daa4f9 /src/model
parentMake send_file use the CreateMessage builder (diff)
downloadserenity-9061c2d859ab4cac27c44f17b1f6d2bb6060b520.tar.xz
serenity-9061c2d859ab4cac27c44f17b1f6d2bb6060b520.zip
Add Context, REST, and model documentation
Add documentation for Context methods, as well as brief documentation for REST functions and model definitions.
Diffstat (limited to 'src/model')
-rw-r--r--src/model/event.rs2
-rw-r--r--src/model/misc.rs1
2 files changed, 3 insertions, 0 deletions
diff --git a/src/model/event.rs b/src/model/event.rs
index 673a3e5..694ebf1 100644
--- a/src/model/event.rs
+++ b/src/model/event.rs
@@ -1,3 +1,5 @@
+//! All the events this library handles.
+
use std::collections::{BTreeMap, HashMap};
use super::utils::*;
use super::*;
diff --git a/src/model/misc.rs b/src/model/misc.rs
index 3a17d96..ebf1979 100644
--- a/src/model/misc.rs
+++ b/src/model/misc.rs
@@ -12,6 +12,7 @@ use super::{
};
use ::internal::prelude::*;
+/// Allows something - such as a channel or role - to be mentioned in a message.
pub trait Mentionable {
fn mention(&self) -> String;
}