aboutsummaryrefslogtreecommitdiff
path: root/src/client
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/client
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/client')
-rw-r--r--src/client/bridge/gateway/mod.rs9
-rw-r--r--src/client/bridge/gateway/shard_manager_monitor.rs2
-rw-r--r--src/client/bridge/gateway/shard_messenger.rs13
-rw-r--r--src/client/bridge/gateway/shard_runner_message.rs2
-rw-r--r--src/client/bridge/mod.rs2
-rw-r--r--src/client/mod.rs23
6 files changed, 25 insertions, 26 deletions
diff --git a/src/client/bridge/gateway/mod.rs b/src/client/bridge/gateway/mod.rs
index 27b5c10..a542dbc 100644
--- a/src/client/bridge/gateway/mod.rs
+++ b/src/client/bridge/gateway/mod.rs
@@ -1,4 +1,4 @@
-//! The client gateway bridge is support essential for the [`client`] module.
+//! The client gateway bridge is support essential for the [`client`][client] module.
//!
//! This is made available for user use if one wishes to be lower-level or avoid
//! the higher functionality of the [`Client`].
@@ -38,13 +38,14 @@
//! For almost every - if not every - use case, you only need to _possibly_ be
//! concerned about the [`ShardManager`] in this module.
//!
+//! [client]: ../../index.html
//! [`Client`]: ../../struct.Client.html
-//! [`client`]: ../..
//! [`Shard`]: ../../../gateway/struct.Shard.html
//! [`ShardManager`]: struct.ShardManager.html
//! [`ShardManager::restart`]: struct.ShardManager.html#method.restart
//! [`ShardManager::shutdown`]: struct.ShardManager.html#method.shutdown
-//! [`ShardQueuer`]: struct.ShardQueuer.html
+//! [`ShardManagerMessage`]: enum.ShardManagerMessage.html
+//! [`ShardQueue`]: struct.ShardQueuer.html
//! [`ShardRunner`]: struct.ShardRunner.html
pub mod event;
@@ -127,7 +128,7 @@ pub enum ShardManagerMessage {
/// This should usually be wrapped in a [`ShardClientMessage`].
///
/// [`ShardClientMessage`]: enum.ShardClientMessage.html
-/// [`ShardQueuer`]: enum.ShardQueuer.html
+/// [`ShardQueuer`]: struct.ShardQueuer.html
#[derive(Clone, Debug)]
pub enum ShardQueuerMessage {
/// Message to start a shard, where the 0-index element is the ID of the
diff --git a/src/client/bridge/gateway/shard_manager_monitor.rs b/src/client/bridge/gateway/shard_manager_monitor.rs
index e9a07cd..4989ef2 100644
--- a/src/client/bridge/gateway/shard_manager_monitor.rs
+++ b/src/client/bridge/gateway/shard_manager_monitor.rs
@@ -12,7 +12,7 @@ use super::{ShardManager, ShardManagerMessage};
/// receiving [`ShardManagerMessage`]s, such as whether to shutdown a shard or
/// shutdown everything entirely.
///
-/// [`ShardManagerMessage`]: struct.ShardManagerMessage.html
+/// [`ShardManagerMessage`]: enum.ShardManagerMessage.html
#[derive(Debug)]
pub struct ShardManagerMonitor {
/// An clone of the Arc to the manager itself.
diff --git a/src/client/bridge/gateway/shard_messenger.rs b/src/client/bridge/gateway/shard_messenger.rs
index a3b5918..11e75ce 100644
--- a/src/client/bridge/gateway/shard_messenger.rs
+++ b/src/client/bridge/gateway/shard_messenger.rs
@@ -106,10 +106,9 @@ impl ShardMessenger {
/// # }
/// ```
///
- /// [`Event::GuildMembersChunk`]:
- /// ../../model/event/enum.Event.html#variant.GuildMembersChunk
- /// [`Guild`]: ../../model/guild/struct.Guild.html
- /// [`Member`]: ../../model/guild/struct.Member.html
+ /// [`Event::GuildMembersChunk`]: ../../../model/event/enum.Event.html#variant.GuildMembersChunk
+ /// [`Guild`]: ../../../model/guild/struct.Guild.html
+ /// [`Member`]: ../../../model/guild/struct.Member.html
pub fn chunk_guilds<It>(
&self,
guild_ids: It,
@@ -261,9 +260,9 @@ impl ShardMessenger {
/// # }
/// ```
///
- /// [`DoNotDisturb`]: ../../model/user/enum.OnlineStatus.html#variant.DoNotDisturb
- /// [`Invisible`]: ../../model/user/enum.OnlineStatus.html#variant.Invisible
- /// [`Offline`]: ../../model/user/enum.OnlineStatus.html#variant.Offline
+ /// [`DoNotDisturb`]: ../../../model/user/enum.OnlineStatus.html#variant.DoNotDisturb
+ /// [`Invisible`]: ../../../model/user/enum.OnlineStatus.html#variant.Invisible
+ /// [`Offline`]: ../../../model/user/enum.OnlineStatus.html#variant.Offline
pub fn set_status(&self, mut online_status: OnlineStatus) {
if online_status == OnlineStatus::Offline {
online_status = OnlineStatus::Invisible;
diff --git a/src/client/bridge/gateway/shard_runner_message.rs b/src/client/bridge/gateway/shard_runner_message.rs
index 29024c9..f281d21 100644
--- a/src/client/bridge/gateway/shard_runner_message.rs
+++ b/src/client/bridge/gateway/shard_runner_message.rs
@@ -17,7 +17,7 @@ pub enum ShardRunnerMessage {
/// The maximum number of members to receive [`GuildMembersChunkEvent`]s
/// for.
///
- /// [`GuildMembersChunkEvent`]: ../../../model/event/GuildMembersChunkEvent.html
+ /// [`GuildMembersChunkEvent`]: ../../../model/event/struct.GuildMembersChunkEvent.html
limit: Option<u16>,
/// Text to filter members by.
///
diff --git a/src/client/bridge/mod.rs b/src/client/bridge/mod.rs
index 41fcdec..a3a431d 100644
--- a/src/client/bridge/mod.rs
+++ b/src/client/bridge/mod.rs
@@ -1,4 +1,4 @@
-//! A collection of bridged support between the [`client`] module and other
+//! A collection of bridged support between the [`client`](../index.html) module and other
//! modules.
//!
//! **Warning**: You likely _do not_ need to mess with anything in here. Beware.
diff --git a/src/client/mod.rs b/src/client/mod.rs
index d5f8711..6fcb84c 100644
--- a/src/client/mod.rs
+++ b/src/client/mod.rs
@@ -92,10 +92,10 @@ use self::bridge::voice::ClientVoiceManager;
/// client.start();
/// ```
///
-/// [`Shard`]: gateway/struct.Shard.html
+/// [`Shard`]: ../gateway/struct.Shard.html
/// [`EventHandler::message`]: trait.EventHandler.html#tymethod.message
/// [`Event::MessageCreate`]: ../model/event/enum.Event.html#variant.MessageCreate
-/// [sharding docs]: gateway/index.html#sharding
+/// [sharding docs]: ../index.html#sharding
pub struct Client {
/// A ShareMap which requires types to be Send + Sync. This is a map that
/// can be safely shared across contexts.
@@ -169,13 +169,12 @@ pub struct Client {
///
/// Refer to [example 05] for an example on using the `data` field.
///
- /// [`Context::data`]: struct.Context.html#method.data
+ /// [`Context::data`]: struct.Context.html#structfield.data
/// [`Event::MessageCreate`]: ../model/event/enum.Event.html#variant.MessageCreate
/// [`Event::MessageDelete`]: ../model/event/enum.Event.html#variant.MessageDelete
/// [`Event::MessageDeleteBulk`]: ../model/event/enum.Event.html#variant.MessageDeleteBulk
/// [`Event::MessageUpdate`]: ../model/event/enum.Event.html#variant.MessageUpdate
- /// [example 05]:
- /// https://github.com/serenity-rs/serenity/tree/master/examples/05_command_framework
+ /// [example 05]: https://github.com/serenity-rs/serenity/tree/master/examples/05_command_framework
pub data: Arc<Mutex<ShareMap>>,
/// A vector of all active shards that have received their [`Event::Ready`]
/// payload, and have dispatched to [`on_ready`] if an event handler was
@@ -387,7 +386,7 @@ impl Client {
}
/// Sets a framework to be used with the client. All message events will be
- /// passed through the framework _after_ being passed to the [`on_message`]
+ /// passed through the framework _after_ being passed to the [`message`]
/// event handler.
///
/// See the [framework module-level documentation][framework docs] for more
@@ -486,7 +485,7 @@ impl Client {
/// Refer to the documentation for the `framework` module for more in-depth
/// information.
///
- /// [`on_message`]: #method.on_message
+ /// [`message`]: trait.EventHandler.html#method.message
/// [framework docs]: ../framework/index.html
#[cfg(feature = "framework")]
pub fn with_framework<F: Framework + Send + 'static>(&mut self, f: F) {
@@ -534,7 +533,7 @@ impl Client {
/// # }
/// ```
///
- /// [gateway docs]: gateway/index.html#sharding
+ /// [gateway docs]: ../gateway/index.html#sharding
pub fn start(&mut self) -> Result<()> {
self.start_connection([0, 0, 1])
}
@@ -586,7 +585,7 @@ impl Client {
/// an error.
///
/// [`ClientError::Shutdown`]: enum.ClientError.html#variant.Shutdown
- /// [gateway docs]: gateway/index.html#sharding
+ /// [gateway docs]: ../gateway/index.html#sharding
pub fn start_autosharded(&mut self) -> Result<()> {
let (x, y) = {
let res = http::get_bot_gateway()?;
@@ -673,7 +672,7 @@ impl Client {
/// [`ClientError::Shutdown`]: enum.ClientError.html#variant.Shutdown
/// [`start`]: #method.start
/// [`start_autosharded`]: #method.start_autosharded
- /// [gateway docs]: gateway/index.html#sharding
+ /// [gateway docs]: ../gateway/index.html#sharding
pub fn start_shard(&mut self, shard: u64, shards: u64) -> Result<()> {
self.start_connection([shard, shard, shards])
}
@@ -727,7 +726,7 @@ impl Client {
/// [`ClientError::Shutdown`]: enum.ClientError.html#variant.Shutdown
/// [`start_shard`]: #method.start_shard
/// [`start_shard_range`]: #method.start_shard_range
- /// [Gateway docs]: gateway/index.html#sharding
+ /// [Gateway docs]: ../gateway/index.html#sharding
pub fn start_shards(&mut self, total_shards: u64) -> Result<()> {
self.start_connection([0, total_shards - 1, total_shards])
}
@@ -797,7 +796,7 @@ impl Client {
/// [`ClientError::Shutdown`]: enum.ClientError.html#variant.Shutdown
/// [`start_shard`]: #method.start_shard
/// [`start_shards`]: #method.start_shards
- /// [Gateway docs]: gateway/index.html#sharding
+ /// [Gateway docs]: ../gateway/index.html#sharding
pub fn start_shard_range(&mut self, range: [u64; 2], total_shards: u64) -> Result<()> {
self.start_connection([range[0], range[1], total_shards])
}