Browse Source

Fix broken cross references

pull/988/head
Hsu Still 7 years ago
parent
commit
16af9ab57a
4 changed files with 11 additions and 14 deletions
  1. +6
    -6
      docs/guides/commands/commands.md
  2. +1
    -4
      docs/guides/concepts/connections.md
  3. +2
    -2
      docs/guides/getting_started/intro.md
  4. +2
    -2
      docs/guides/voice/sending-voice.md

+ 6
- 6
docs/guides/commands/commands.md View File

@@ -153,7 +153,7 @@ Invoke [CommandService.AddModulesAsync] to discover modules and
install them. install them.


[DontAutoLoadAttribute]: xref:Discord.Commands.DontAutoLoadAttribute [DontAutoLoadAttribute]: xref:Discord.Commands.DontAutoLoadAttribute
[CommandService.AddModulesAsync]: xref:Discord.Commands.CommandService#Discord_Commands_CommandService_AddModulesAsync_Assembly_
[CommandService.AddModulesAsync]: xref:Discord.Commands.CommandService#Discord_Commands_CommandService_AddModulesAsync_Assembly_System_IServiceProvider_


#### Loading Modules Manually #### Loading Modules Manually


@@ -161,7 +161,7 @@ To manually load a module, invoke [CommandService.AddModuleAsync] by
passing in the generic type of your module and optionally, a passing in the generic type of your module and optionally, a
dependency map. dependency map.


[CommandService.AddModuleAsync]: xref:Discord.Commands.CommandService#Discord_Commands_CommandService_AddModuleAsync__1
[CommandService.AddModuleAsync]: xref:Discord.Commands.CommandService#Discord_Commands_CommandService_AddModuleAsync__1_System_IServiceProvider_


### Module Constructors ### Module Constructors


@@ -268,7 +268,7 @@ either [PreconditionAttribute] or [ParameterPreconditionAttribute]
depending on your use. depending on your use.


In order for your Precondition to function, you will need to override In order for your Precondition to function, you will need to override
the [CheckPermissions] method.
the [CheckPermissionsAsync] method.


Your IDE should provide an option to fill this in for you. Your IDE should provide an option to fill this in for you.


@@ -279,7 +279,7 @@ necessary.


[!code-csharp[Custom Precondition](samples/require_owner.cs)] [!code-csharp[Custom Precondition](samples/require_owner.cs)]


[CheckPermissions]: xref:Discord.Commands.PreconditionAttribute#Discord_Commands_PreconditionAttribute_CheckPermissions_Discord_Commands_ICommandContext_Discord_Commands_CommandInfo_IServiceProvider_
[CheckPermissionsAsync]: xref:Discord.Commands.PreconditionAttribute#Discord_Commands_PreconditionAttribute_CheckPermissionsAsync_Discord_Commands_ICommandContext_Discord_Commands_CommandInfo_System_IServiceProvider_
[PreconditionResult.FromSuccess]: xref:Discord.Commands.PreconditionResult#Discord_Commands_PreconditionResult_FromSuccess [PreconditionResult.FromSuccess]: xref:Discord.Commands.PreconditionResult#Discord_Commands_PreconditionResult_FromSuccess
[PreconditionResult.FromError]: xref:Discord.Commands.PreconditionResult#Discord_Commands_PreconditionResult_FromError_System_String_ [PreconditionResult.FromError]: xref:Discord.Commands.PreconditionResult#Discord_Commands_PreconditionResult_FromError_System_String_


@@ -310,7 +310,7 @@ To create a `TypeReader`, create a new class that imports @Discord and
@Discord.Commands and ensure the class inherits from @Discord.Commands and ensure the class inherits from
@Discord.Commands.TypeReader. @Discord.Commands.TypeReader.


Next, satisfy the `TypeReader` class by overriding the [Read] method.
Next, satisfy the `TypeReader` class by overriding the [ReadAsync] method.


>[!NOTE] >[!NOTE]
>In many cases, Visual Studio can fill this in for you, using the >In many cases, Visual Studio can fill this in for you, using the
@@ -327,7 +327,7 @@ necessary.
[TypeReaderResult]: xref:Discord.Commands.TypeReaderResult [TypeReaderResult]: xref:Discord.Commands.TypeReaderResult
[TypeReaderResult.FromSuccess]: xref:Discord.Commands.TypeReaderResult#Discord_Commands_TypeReaderResult_FromSuccess_Discord_Commands_TypeReaderValue_ [TypeReaderResult.FromSuccess]: xref:Discord.Commands.TypeReaderResult#Discord_Commands_TypeReaderResult_FromSuccess_Discord_Commands_TypeReaderValue_
[TypeReaderResult.FromError]: xref:Discord.Commands.TypeReaderResult#Discord_Commands_TypeReaderResult_FromError_Discord_Commands_CommandError_System_String_ [TypeReaderResult.FromError]: xref:Discord.Commands.TypeReaderResult#Discord_Commands_TypeReaderResult_FromError_Discord_Commands_CommandError_System_String_
[Read]: xref:Discord.Commands.TypeReader#Discord_Commands_TypeReader_Read_Discord_Commands_ICommandContext_System_String_IServiceProvider_
[ReadAsync]: xref:Discord.Commands.TypeReader#Discord_Commands_TypeReader_ReadAsync_Discord_Commands_ICommandContext_System_String_System_IServiceProvider_


#### Sample #### Sample




+ 1
- 4
docs/guides/concepts/connections.md View File

@@ -11,9 +11,6 @@ stopped.
To start a connection, invoke the `StartAsync` method on a client that To start a connection, invoke the `StartAsync` method on a client that
supports a WebSocket connection. supports a WebSocket connection.


These clients include the [DiscordSocketClient] and
[DiscordRpcClient], as well as Audio clients.

To end a connection, invoke the `StopAsync` method. This will To end a connection, invoke the `StopAsync` method. This will
gracefully close any open WebSocket or UdpSocket connections. gracefully close any open WebSocket or UdpSocket connections.


@@ -55,4 +52,4 @@ Don't worry about trying to maintain your own connections, the
connection manager is designed to be bulletproof and never fail - if connection manager is designed to be bulletproof and never fail - if
your client doesn't manage to reconnect, you've found a bug! your client doesn't manage to reconnect, you've found a bug!


[events]: events.md
[events]: events.md

+ 2
- 2
docs/guides/getting_started/intro.md View File

@@ -212,7 +212,7 @@ shown below.


For your reference, you may view the [completed program]. For your reference, you may view the [completed program].


[MessageReceived]: xref:Discord.WebSocket.DiscordSocketClient#Discord_WebSocket_DiscordSocketClient_MessageReceived
[MessageReceived]: xref:Discord.WebSocket.BaseSocketClient#Discord_WebSocket_BaseSocketClient_MessageReceived
[SocketMessage]: xref:Discord.WebSocket.SocketMessage [SocketMessage]: xref:Discord.WebSocket.SocketMessage
[SocketMessageChannel]: xref:Discord.WebSocket.ISocketMessageChannel [SocketMessageChannel]: xref:Discord.WebSocket.ISocketMessageChannel
[completed program]: samples/intro/complete.cs [completed program]: samples/intro/complete.cs
@@ -234,4 +234,4 @@ should be to separate the program (initialization and command handler),
the modules (handle commands), and the services (persistent storage, the modules (handle commands), and the services (persistent storage,
pure functions, data manipulation). pure functions, data manipulation).


**todo:** diagram of bot structure
**todo:** diagram of bot structure

+ 2
- 2
docs/guides/voice/sending-voice.md View File

@@ -44,7 +44,7 @@ guild. To switch channels within a guild, invoke [ConnectAsync] on
another voice channel in the guild. another voice channel in the guild.


[IAudioClient]: xref:Discord.Audio.IAudioClient [IAudioClient]: xref:Discord.Audio.IAudioClient
[ConnectAsync]: xref:Discord.IAudioChannel#Discord_IAudioChannel_ConnectAsync_Action_IAudioClient__
[ConnectAsync]: xref:Discord.IAudioChannel#Discord_IAudioChannel_ConnectAsync_System_Action_IAudioClient__


## Transmitting Audio ## Transmitting Audio


@@ -98,4 +98,4 @@ you will want to wait for audio to stop playing before continuing on
to the next song. You can await `AudioOutStream.FlushAsync` to wait for to the next song. You can await `AudioOutStream.FlushAsync` to wait for
the audio client's internal buffer to clear out. the audio client's internal buffer to clear out.


[!code-csharp[Sending Audio](samples/audio_ffmpeg.cs)]
[!code-csharp[Sending Audio](samples/audio_ffmpeg.cs)]

Loading…
Cancel
Save