aboutsummaryrefslogtreecommitdiff
path: root/src/framework
diff options
context:
space:
mode:
authorErk- <[email protected]>2018-08-09 20:34:33 +0200
committerzeyla <[email protected]>2018-08-09 11:34:33 -0700
commit40053a71931bb63c43eb6f469ee3c94383c9e90a (patch)
tree79c2fabc1229d0543205bc6daf8ebebc6ebc9755 /src/framework
parent[routing] Fix various incorrect routes. (#364) (diff)
downloadserenity-40053a71931bb63c43eb6f469ee3c94383c9e90a.tar.xz
serenity-40053a71931bb63c43eb6f469ee3c94383c9e90a.zip
Fix all the dead links in the docs
Diffstat (limited to 'src/framework')
-rw-r--r--src/framework/standard/configuration.rs4
-rw-r--r--src/framework/standard/mod.rs25
2 files changed, 14 insertions, 15 deletions
diff --git a/src/framework/standard/configuration.rs b/src/framework/standard/configuration.rs
index c237286..795493d 100644
--- a/src/framework/standard/configuration.rs
+++ b/src/framework/standard/configuration.rs
@@ -10,7 +10,7 @@ use std::{
};
use super::command::PrefixCheck;
-/// The configuration to use for a [`Framework`] associated with a [`Client`]
+/// The configuration to use for a [`StandardFramework`] associated with a [`Client`]
/// instance.
///
/// This allows setting configurations like the depth to search for commands,
@@ -40,7 +40,7 @@ use super::command::PrefixCheck;
/// ```
///
/// [`Client`]: ../../client/struct.Client.html
-/// [`Framework`]: struct.Framework.html
+/// [`StandardFramework`]: struct.StandardFramework.html
/// [default implementation]: #impl-Default
pub struct Configuration {
#[doc(hidden)] pub allow_dm: bool,
diff --git a/src/framework/standard/mod.rs b/src/framework/standard/mod.rs
index 52b955b..8731372 100644
--- a/src/framework/standard/mod.rs
+++ b/src/framework/standard/mod.rs
@@ -53,12 +53,12 @@ use client::CACHE;
#[cfg(feature = "cache")]
use model::channel::Channel;
-/// A convenience macro for generating a struct fulfilling the [`Command`] trait.
+/// A convenience macro for generating a struct fulfilling the [`Command`][command trait] trait.
///
-/// This is meant for use with the [`Framework`], specifically `Framework`::{[`cmd`]/[`command`]}.
+/// This is meant for use with the [`StandardFramework`], specifically `Framework`::{[`cmd`]/[`command`]}.
///
///
-/// If you're just looking for a simple "register this function as a command", use [`Framework::on`].
+/// If you're just looking for a simple "register this function as a command", use [`StandardFramework::on`].
///
/// # Examples
///
@@ -87,11 +87,11 @@ use model::channel::Channel;
/// });
/// ```
///
-/// [`Framework`]: framework/index.html
-/// [`cmd`]: struct.Framework.html#method.cmd
-/// [`command`]: struct.Framework.html#method.command
-/// [`Framework::on`]: struct.Framework.html#method.on
-/// [`Command`]: trait.Command.html
+/// [command trait]: framework/standard/trait.Command.html
+/// [`StandardFramework`]: framework/standard/struct.StandardFramework.html
+/// [`cmd`]: framework/standard/struct.StandardFramework.html#method.cmd
+/// [`command`]: framework/standard/struct.StandardFramework.html#method.command
+/// [`StandardFramework::on`]: framework/standard/struct.StandardFramework.html#method.on
#[macro_export]
macro_rules! command {
($fname:ident($c:ident) $b:block) => {
@@ -215,13 +215,12 @@ pub struct StandardFramework {
/// - a command check has been set.
///
/// This is used internally to determine whether or not - in addition to
- /// dispatching to the [`EventHandler::on_message`] handler - to have the
+ /// dispatching to the [`EventHandler::message`] handler - to have the
/// framework check if a [`Event::MessageCreate`] should be processed by
/// itself.
///
- /// [`EventHandler::on_message`]:
- /// ../client/event_handler/trait.EventHandler.html#method.on_message
- /// [`Event::MessageCreate`]: ../model/event/enum.Event.html#variant.MessageCreate
+ /// [`EventHandler::message`]: ../../client/trait.EventHandler.html#method.message
+ /// [`Event::MessageCreate`]: ../../model/event/enum.Event.html#variant.MessageCreate
pub initialized: bool,
user_id: u64,
}
@@ -255,7 +254,7 @@ impl StandardFramework {
/// .prefix("~")));
/// ```
///
- /// [`Client`]: ../client/struct.Client.html
+ /// [`Client`]: ../../client/struct.Client.html
/// [`Configuration::default`]: struct.Configuration.html#method.default
/// [`depth`]: struct.Configuration.html#method.depth
/// [`prefix`]: struct.Configuration.html#method.prefix