aboutsummaryrefslogtreecommitdiff
path: root/src/builder
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2018-01-31 14:56:12 -0800
committerZeyla Hellyer <[email protected]>2018-01-31 14:56:56 -0800
commit8578d5fe6e3bdc2842cda9417c242169f93b1a99 (patch)
treeba5ce74c82510f5d3b6b490b09eb5e6d2de77ca1 /src/builder
parentAdd create message builder example (#268) (diff)
downloadserenity-8578d5fe6e3bdc2842cda9417c242169f93b1a99.tar.xz
serenity-8578d5fe6e3bdc2842cda9417c242169f93b1a99.zip
Fix broken docs links caused by model mod changes
Fix broken links caused by the `model` module changes in v0.5.0, which split up the module into sub-modules for better organization.
Diffstat (limited to 'src/builder')
-rw-r--r--src/builder/create_embed.rs12
-rw-r--r--src/builder/create_invite.rs4
-rw-r--r--src/builder/create_message.rs6
-rw-r--r--src/builder/edit_channel.rs14
-rw-r--r--src/builder/edit_guild.rs15
-rw-r--r--src/builder/edit_member.rs4
-rw-r--r--src/builder/edit_profile.rs2
-rw-r--r--src/builder/edit_role.rs16
-rw-r--r--src/builder/execute_webhook.rs10
-rw-r--r--src/builder/get_messages.rs2
10 files changed, 42 insertions, 43 deletions
diff --git a/src/builder/create_embed.rs b/src/builder/create_embed.rs
index d36ad3e..f420a8c 100644
--- a/src/builder/create_embed.rs
+++ b/src/builder/create_embed.rs
@@ -10,7 +10,7 @@
//!
//! Documentation for embeds can be found [here].
//!
-//! [`ChannelId::send_message`]: ../model/struct.ChannelId.html#method.send_message
+//! [`ChannelId::send_message`]: ../model/id/struct.ChannelId.html#method.send_message
//! [`CreateEmbed`]: struct.CreateEmbed.html
//! [`ExecuteWebhook::embeds`]: struct.ExecuteWebhook.html#method.embeds
//! [here]: https://discordapp.com/developers/docs/resources/channel#embed-object
@@ -35,8 +35,8 @@ use utils::Colour;
/// Refer to the documentation for [`ChannelId::send_message`] for a very in-depth
/// example on how to use this.
///
-/// [`ChannelId::send_message`]: ../model/struct.ChannelId.html#method.send_message
-/// [`Embed`]: ../model/struct.Embed.html
+/// [`ChannelId::send_message`]: ../model/id/struct.ChannelId.html#method.send_message
+/// [`Embed`]: ../model/channel/struct.Embed.html
/// [`ExecuteWebhook::embeds`]: struct.ExecuteWebhook.html#method.embeds
#[derive(Clone, Debug)]
pub struct CreateEmbed(pub VecMap<&'static str, Value>);
@@ -300,7 +300,7 @@ impl CreateEmbed {
/// Note however, you have to be sure you set an attachment (with [`ChannelId::send_files`])
/// with the provided filename. Or else this won't work.
///
- /// [`ChannelId::send_files`]: ../model/struct.ChannelId.html#send_files
+ /// [`ChannelId::send_files`]: ../model/id/struct.ChannelId.html#send_files
pub fn attachment(self, filename: &str) -> Self {
self.image(&format!("attachment://{}", filename))
}
@@ -388,7 +388,7 @@ impl From<Embed> for CreateEmbed {
///
/// Requires that you specify a [`name`].
///
-/// [`Embed`]: ../model/struct.Embed.html
+/// [`Embed`]: ../model/channel/struct.Embed.html
/// [`CreateEmbed::author`]: struct.CreateEmbed.html#method.author
/// [`name`]: #method.name
#[derive(Clone, Debug, Default)]
@@ -422,7 +422,7 @@ impl CreateEmbedAuthor {
///
/// This does not require any field be set.
///
-/// [`Embed`]: ../model/struct.Embed.html
+/// [`Embed`]: ../model/channel/struct.Embed.html
/// [`CreateEmbed::footer`]: struct.CreateEmbed.html#method.footer
#[derive(Clone, Debug, Default)]
pub struct CreateEmbedFooter(pub VecMap<&'static str, Value>);
diff --git a/src/builder/create_invite.rs b/src/builder/create_invite.rs
index b3344cc..c9b00ff 100644
--- a/src/builder/create_invite.rs
+++ b/src/builder/create_invite.rs
@@ -59,8 +59,8 @@ use utils::VecMap;
/// client.start().unwrap();
/// ```
///
-/// [`GuildChannel::create_invite`]: ../model/struct.GuildChannel.html#method.create_invite
-/// [`RichInvite`]: ../model/struct.Invite.html
+/// [`GuildChannel::create_invite`]: ../model/guild/struct.GuildChannel.html#method.create_invite
+/// [`RichInvite`]: ../model/guild/struct.Invite.html
#[derive(Clone, Debug)]
pub struct CreateInvite(pub VecMap<&'static str, Value>);
diff --git a/src/builder/create_message.rs b/src/builder/create_message.rs
index 2a89c0b..07242f0 100644
--- a/src/builder/create_message.rs
+++ b/src/builder/create_message.rs
@@ -34,8 +34,8 @@ use utils::{self, VecMap};
/// .description("With a description")));
/// ```
///
-/// [`ChannelId::say`]: ../model/struct.ChannelId.html#method.say
-/// [`ChannelId::send_message`]: ../model/struct.ChannelId.html#method.send_message
+/// [`ChannelId::say`]: ../model/id/struct.ChannelId.html#method.say
+/// [`ChannelId::send_message`]: ../model/id/struct.ChannelId.html#method.send_message
/// [`content`]: #method.content
/// [`embed`]: #method.embed
/// [`http::send_message`]: ../http/fn.send_message.html
@@ -86,7 +86,7 @@ impl Default for CreateMessage {
/// Creates a map for sending a [`Message`], setting [`tts`] to `false` by
/// default.
///
- /// [`Message`]: ../model/struct.Message.html
+ /// [`Message`]: ../model/channel/struct.Message.html
/// [`tts`]: #method.tts
fn default() -> CreateMessage {
let mut map = VecMap::new();
diff --git a/src/builder/edit_channel.rs b/src/builder/edit_channel.rs
index 2ea5707..b8d897b 100644
--- a/src/builder/edit_channel.rs
+++ b/src/builder/edit_channel.rs
@@ -17,8 +17,8 @@ use model::id::ChannelId;
/// }
/// ```
///
-/// [`GuildChannel`]: ../model/struct.GuildChannel.html
-/// [`GuildChannel::edit`]: ../model/struct.GuildChannel.html#method.edit
+/// [`GuildChannel`]: ../model/channel/struct.GuildChannel.html
+/// [`GuildChannel::edit`]: ../model/channel/struct.GuildChannel.html#method.edit
#[derive(Clone, Debug, Default)]
pub struct EditChannel(pub VecMap<&'static str, Value>);
@@ -27,7 +27,7 @@ impl EditChannel {
///
/// This is for [voice] channels only.
///
- /// [voice]: ../model/enum.ChannelType.html#variant.Voice
+ /// [voice]: ../model/channel/enum.ChannelType.html#variant.Voice
pub fn bitrate(mut self, bitrate: u64) -> Self {
self.0.insert("bitrate", Value::Number(Number::from(bitrate)));
@@ -56,7 +56,7 @@ impl EditChannel {
///
/// This is for [text] channels only.
///
- /// [text]: ../model/enum.ChannelType.html#variant.Text
+ /// [text]: ../model/channel/enum.ChannelType.html#variant.Text
pub fn topic(mut self, topic: &str) -> Self {
self.0.insert("topic", Value::String(topic.to_string()));
@@ -67,7 +67,7 @@ impl EditChannel {
///
/// This is for [voice] channels only.
///
- /// [voice]: ../model/enum.ChannelType.html#variant.Voice
+ /// [voice]: ../model/channel/enum.ChannelType.html#variant.Voice
pub fn user_limit(mut self, user_limit: u64) -> Self {
self.0.insert("user_limit", Value::Number(Number::from(user_limit)));
@@ -78,8 +78,8 @@ impl EditChannel {
///
/// This is for [text] and [voice] channels only.
///
- /// [text]: ../model/enum.ChannelType.html#variant.Text
- /// [voice]: ../model/enum.ChannelType.html#variant.Voice
+ /// [text]: ../model/channel/enum.ChannelType.html#variant.Text
+ /// [voice]: ../model/channel/enum.ChannelType.html#variant.Voice
pub fn category<C>(mut self, category: C) -> Self
where C: Into<Option<ChannelId>> {
let parent_id = match category.into() {
diff --git a/src/builder/edit_guild.rs b/src/builder/edit_guild.rs
index ee6bce6..c24b9b4 100644
--- a/src/builder/edit_guild.rs
+++ b/src/builder/edit_guild.rs
@@ -8,8 +8,8 @@ use utils::VecMap;
/// **Note**: Editing a guild requires that the current user have the
/// [Manage Guild] permission.
///
-/// [`Guild::edit`]: ../model/struct.Guild.html#method.edit
-/// [`Guild`]: ../model/struct.Guild.html
+/// [`Guild::edit`]: ../model/guild/struct.Guild.html#method.edit
+/// [`Guild`]: ../model/guild/struct.Guild.html
/// [Manage Guild]: ../model/permissions/constant.MANAGE_GUILD.html
#[derive(Clone, Debug, Default)]
pub struct EditGuild(pub VecMap<&'static str, Value>);
@@ -130,7 +130,7 @@ impl EditGuild {
/// # }
/// ```
///
- /// [`Region::UsWest`]: ../model/enum.Region.html#variant.UsWest
+ /// [`Region::UsWest`]: ../model/guild/enum.Region.html#variant.UsWest
pub fn region(mut self, region: Region) -> Self {
self.0.insert("region", Value::String(region.name().to_string()));
@@ -139,11 +139,10 @@ impl EditGuild {
/// Set the splash image of the guild on the invitation page.
///
- /// Requires that the guild have the [`InviteSplash`] feature enabled.
+ /// Requires that the guild have the `INVITE_SPLASH` feature enabled.
/// You can check this through a guild's [`features`] list.
///
- /// [`InviteSplash`]: ../model/enum.Feature.html#variant.InviteSplash
- /// [`features`]: ../model/struct.LiveGuild.html#structfield.features
+ /// [`features`]: ../model/guild/struct.Guild.html#structfield.features
pub fn splash(mut self, splash: Option<&str>) -> Self {
let splash = splash.map_or(Value::Null, |x| Value::String(x.to_string()));
self.0.insert("splash", splash);
@@ -179,8 +178,8 @@ impl EditGuild {
/// }
/// ```
///
- /// [`VerificationLevel`]: ../model/enum.VerificationLevel.html
- /// [`VerificationLevel::High`]: ../model/enum.VerificationLevel.html#variant.High
+ /// [`VerificationLevel`]: ../model/guild/enum.VerificationLevel.html
+ /// [`VerificationLevel::High`]: ../model/guild/enum.VerificationLevel.html#variant.High
pub fn verification_level<V>(mut self, verification_level: V) -> Self
where V: Into<VerificationLevel> {
let num = Value::Number(Number::from(verification_level.into().num()));
diff --git a/src/builder/edit_member.rs b/src/builder/edit_member.rs
index efc9fb9..19edb5e 100644
--- a/src/builder/edit_member.rs
+++ b/src/builder/edit_member.rs
@@ -5,8 +5,8 @@ use utils::VecMap;
/// A builder which edits the properties of a [`Member`], to be used in
/// conjunction with [`Member::edit`].
///
-/// [`Member`]: ../model/struct.Member.html
-/// [`Member::edit`]: ../model/struct.Member.html#method.edit
+/// [`Member`]: ../model/guild/struct.Member.html
+/// [`Member::edit`]: ../model/guild/struct.Member.html#method.edit
#[derive(Clone, Debug, Default)]
pub struct EditMember(pub VecMap<&'static str, Value>);
diff --git a/src/builder/edit_profile.rs b/src/builder/edit_profile.rs
index e27fb92..df428b4 100644
--- a/src/builder/edit_profile.rs
+++ b/src/builder/edit_profile.rs
@@ -4,7 +4,7 @@ use utils::VecMap;
/// A builder to edit the current user's settings, to be used in conjunction
/// with [`CurrentUser::edit`].
///
-/// [`CurrentUser::edit`]: ../model/struct.CurrentUser.html#method.edit
+/// [`CurrentUser::edit`]: ../model/user/struct.CurrentUser.html#method.edit
#[derive(Clone, Debug, Default)]
pub struct EditProfile(pub VecMap<&'static str, Value>);
diff --git a/src/builder/edit_role.rs b/src/builder/edit_role.rs
index 54511ec..9f0fce1 100644
--- a/src/builder/edit_role.rs
+++ b/src/builder/edit_role.rs
@@ -32,20 +32,20 @@ use utils::VecMap;
/// .name("a test role"));
/// ```
///
-/// [`PartialGuild::create_role`]: ../model/struct.PartialGuild.html#method.create_role
-/// [`Guild::create_role`]: ../model/struct.Guild.html#method.create_role
-/// [`Guild::edit_role`]: ../model/struct.Guild.html#method.edit_role
-/// [`GuildId::create_role`]: ../model/struct.GuildId.html#method.create_role
-/// [`GuildId::edit_role`]: ../model/struct.GuildId.html#method.edit_role
-/// [`Role`]: ../model/struct.Role.html
-/// [`Role::edit`]: ../model/struct.Role.html#method.edit
+/// [`PartialGuild::create_role`]: ../model/guild/struct.PartialGuild.html#method.create_role
+/// [`Guild::create_role`]: ../model/guild/struct.Guild.html#method.create_role
+/// [`Guild::edit_role`]: ../model/guild/struct.Guild.html#method.edit_role
+/// [`GuildId::create_role`]: ../model/id/struct.GuildId.html#method.create_role
+/// [`GuildId::edit_role`]: ../model/id/struct.GuildId.html#method.edit_role
+/// [`Role`]: ../model/guild/struct.Role.html
+/// [`Role::edit`]: ../model/guild/struct.Role.html#method.edit
#[derive(Clone, Debug, Default)]
pub struct EditRole(pub VecMap<&'static str, Value>);
impl EditRole {
/// Creates a new builder with the values of the given [`Role`].
///
- /// [`Role`]: ../model/struct.Role.html
+ /// [`Role`]: ../model/guild/struct.Role.html
pub fn new(role: &Role) -> Self {
let mut map = VecMap::with_capacity(8);
diff --git a/src/builder/execute_webhook.rs b/src/builder/execute_webhook.rs
index 26600ef..65823bb 100644
--- a/src/builder/execute_webhook.rs
+++ b/src/builder/execute_webhook.rs
@@ -43,8 +43,8 @@ use utils::VecMap;
/// .embeds(vec![website, resources]));
/// ```
///
-/// [`Webhook`]: ../model/struct.Webhook.html
-/// [`Webhook::execute`]: ../model/struct.Webhook.html#method.execute
+/// [`Webhook`]: ../model/webhook/struct.Webhook.html
+/// [`Webhook::execute`]: ../model/webhook/struct.Webhook.html#method.execute
/// [`execute_webhook`]: ../http/fn.execute_webhook.html
#[derive(Clone, Debug)]
pub struct ExecuteWebhook(pub VecMap<&'static str, Value>);
@@ -109,8 +109,8 @@ impl ExecuteWebhook {
/// Refer to the [struct-level documentation] for an example on how to use
/// embeds.
///
- /// [`Embed::fake`]: ../model/struct.Embed.html#method.fake
- /// [`Webhook::execute`]: ../model/struct.Webhook.html#method.execute
+ /// [`Embed::fake`]: ../model/channel/struct.Embed.html#method.fake
+ /// [`Webhook::execute`]: ../model/webhook/struct.Webhook.html#method.execute
/// [struct-level documentation]: #examples
pub fn embeds(mut self, embeds: Vec<Value>) -> Self {
self.0.insert("embeds", Value::Array(embeds));
@@ -176,7 +176,7 @@ impl Default for ExecuteWebhook {
/// let executer = ExecuteWebhook::default();
/// ```
///
- /// [`Webhook`]: ../model/struct.Webhook.html
+ /// [`Webhook`]: ../model/webhook/struct.Webhook.html
/// [`tts`]: #method.tts
fn default() -> ExecuteWebhook {
let mut map = VecMap::new();
diff --git a/src/builder/get_messages.rs b/src/builder/get_messages.rs
index 01003f6..f302ff0 100644
--- a/src/builder/get_messages.rs
+++ b/src/builder/get_messages.rs
@@ -48,7 +48,7 @@ use utils::VecMap;
/// # }
/// ```
///
-/// [`GuildChannel::messages`]: ../model/struct.GuildChannel.html#method.messages
+/// [`GuildChannel::messages`]: ../model/channel/struct.GuildChannel.html#method.messages
#[derive(Clone, Debug, Default)]
pub struct GetMessages(pub VecMap<&'static str, u64>);