Skip to content

Commit

Permalink
Fix dead doc-links and add missing ones. (#347)
Browse files Browse the repository at this point in the history
  • Loading branch information
Lakelezz authored and arqunis committed Jul 4, 2018
1 parent 55555b8 commit 4cf83d0
Showing 1 changed file with 40 additions and 33 deletions.
73 changes: 40 additions & 33 deletions src/model/event.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ use std::mem;
/// - A [`PrivateChannel`] is created
/// - The current user is added to a [`Group`]
///
/// [`Channel`]: ../enum.Channel.html
/// [`Group`]: ../struct.Group.html
/// [`Guild`]: ../struct.Guild.html
/// [`Channel`]: ../channel/enum.Channel.html
/// [`Group`]: ../channel/struct.Group.html
/// [`Guild`]: ../guild/struct.Guild.html
/// [`PrivateChannel`]: ../struct.PrivateChannel.html
#[derive(Clone, Debug)]
pub struct ChannelCreateEvent {
Expand Down Expand Up @@ -1252,45 +1252,51 @@ impl<'de> Deserialize<'de> for GatewayEvent {
pub enum Event {
/// A [`Channel`] was created.
///
/// Fires the [`Client::on_channel_create`] event.
/// Fires the [`Client::channel_create`] event.
///
/// [`Channel`]: ../enum.Channel.html
/// [`Client::on_channel_create`]: ../../client/struct.Client.html#on_channel_create
/// [`Channel`]: ../channel/enum.Channel.html
/// [`Client::channel_create`]: ../../client/struct.Client.html#channel_create
ChannelCreate(ChannelCreateEvent),
/// A [`Channel`] has been deleted.
///
/// Fires the [`Client::on_channel_delete`] event.
/// Fires the [`Client::channel_delete`] event.
///
/// [`Channel`]: ../enum.Channel.html
/// [`Channel`]: ../channel/enum.Channel.html
/// [`Client::channel_delete`]:
/// ../../client/struct.Client.html#channel_delete
ChannelDelete(ChannelDeleteEvent),
/// The pins for a [`Channel`] have been updated.
///
/// Fires the [`Client::on_channel_pins_update`] event.
/// Fires the [`Client::channel_pins_update`] event.
///
/// [`Channel`]: ../enum.Channel.html
/// [`Client::on_channel_pins_update`]:
/// ../../client/struct.Client.html#on_channel_pins_update
/// [`Channel`]: ../channel/enum.Channel.html
/// [`Client::channel_pins_update`]:
/// ../../client/struct.Client.html#channel_pins_update
ChannelPinsUpdate(ChannelPinsUpdateEvent),
/// A [`User`] has been added to a [`Group`].
///
/// Fires the [`Client::on_recipient_add`] event.
/// Fires the [`Client::recipient_add`] event.
///
/// [`Client::on_recipient_add`]: ../../client/struct.Client.html#on_recipient_add
/// [`User`]: ../struct.User.html
/// [`Client::recipient_add`]: ../../client/struct.Client.html#recipient_add
/// [`User`]: ../user/struct.User.html
/// [`Group`]: ../channel/struct.Group.html
ChannelRecipientAdd(ChannelRecipientAddEvent),
/// A [`User`] has been removed from a [`Group`].
///
/// Fires the [`Client::on_recipient_remove`] event.
/// Fires the [`Client::recipient_remove`] event.
///
/// [`Client::on_recipient_remove`]: ../../client/struct.Client.html#on_recipient_remove
/// [`User`]: ../struct.User.html
/// [`Channel`]: ../channel/enum.Channel.html
/// [`Client::recipient_remove`]: ../../client/struct.Client.html#recipient_remove
/// [`User`]: ../user/struct.User.html
/// [`Group`]: ../channel/struct.Group.html
ChannelRecipientRemove(ChannelRecipientRemoveEvent),
/// A [`Channel`] has been updated.
///
/// Fires the [`Client::on_channel_update`] event.
/// Fires the [`Client::channel_update`] event.
///
/// [`Client::on_channel_update`]: ../../client/struct.Client.html#on_channel_update
/// [`User`]: ../struct.User.html
/// [`Channel`]: ../channel/enum.Channel.html
/// [`Client::channel_update`]: ../../client/struct.Client.html#channel_update
/// [`User`]: ../user/struct.User.html
ChannelUpdate(ChannelUpdateEvent),
GuildBanAdd(GuildBanAddEvent),
GuildBanRemove(GuildBanRemoveEvent),
Expand Down Expand Up @@ -1320,24 +1326,24 @@ pub enum Event {
PresencesReplace(PresencesReplaceEvent),
/// A reaction was added to a message.
///
/// Fires the [`on_message_reaction_add`] event handler.
/// Fires the [`reaction_add`] event handler.
///
/// [`on_message_reaction_add`]: ../client/struct.Client.html#method.on_message_reaction_add
/// [`reaction_add`]: ../../prelude/trait.EventHandler.html#method.reaction_add
ReactionAdd(ReactionAddEvent),
/// A reaction was removed to a message.
///
/// Fires the [`on_message_reaction_remove`] event handler.
/// Fires the [`reaction_remove`] event handler.
///
/// [`on_message_reaction_remove`]:
/// ../client/struct.Client.html#method.on_message_reaction_remove
/// [`reaction_remove`]:
/// ../../prelude/trait.EventHandler.html#method.reaction_remove
ReactionRemove(ReactionRemoveEvent),
/// A request was issued to remove all [`Reaction`]s from a [`Message`].
///
/// Fires the [`on_reaction_remove_all`] event handler.
/// Fires the [`reaction_remove_all`] event handler.
///
/// [`Message`]: struct.Message.html
/// [`Reaction`]: struct.Reaction.html
/// [`on_reaction_remove_all`]: ../client/struct.Clint.html#method.on_reaction_remove_all
/// [`Message`]: ../channel/struct.Message.html
/// [`Reaction`]: ../channel/struct.Reaction.html
/// [`reaction_remove_all`]: ../../prelude/trait.EventHandler.html#method.reaction_remove_all
ReactionRemoveAll(ReactionRemoveAllEvent),
/// The first event in a connection, containing the initial ready cache.
///
Expand All @@ -1353,10 +1359,11 @@ pub enum Event {
VoiceStateUpdate(VoiceStateUpdateEvent),
/// Voice server information is available
VoiceServerUpdate(VoiceServerUpdateEvent),
/// A webhook for a [channel][`GuildChannel`] was updated in a [`Guild`].
/// A webhook for a [`Channel`]-variant [`GuildChannel`] was updated in a [`Guild`].
///
/// [`Guild`]: struct.Guild.html
/// [`GuildChannel`]: struct.GuildChannel.html
/// [`Channel`]: ../channel/enum.Channel.html
/// [`GuildChannel`]: ../channel/enum.Channel.html#variant.Guild
/// [`Guild`]: ../guild/struct.Guild.html
WebhookUpdate(WebhookUpdateEvent),
/// An event type not covered by the above
Unknown(UnknownEvent),
Expand Down

0 comments on commit 4cf83d0

Please sign in to comment.