Fix Samples on Docs; Fix Links on Docs; add FAQ page to docs

This commit is contained in:
Christopher F
2016-07-29 20:48:33 -04:00
parent dc58f92333
commit af4ede31b8
13 changed files with 51 additions and 3 deletions

File diff suppressed because one or more lines are too long

20
docs/guides/faq.md Normal file
View File

@@ -0,0 +1,20 @@
---
title: Frequently Asked Questions
---
# Frequently Asked Questions
>[!NOTE]
>All of these samples assume you have `_client` defined as a `DiscordSocketClient`.
#### Changing the bot's avatar
[!code-csharp[Bot Avatar](samples/faq/avatar.cs)]
#### Changing the bot's status
[!code-sharp[Bot Status](samples/faq/status.cs)]
#### Sending a message to a channel
[!code-csharp[Message to Channel](samples/faq/send_message.cs)]

View File

@@ -1,6 +1,7 @@
using System.Threading.Tasks;
using System.Reflection;
using Discord;
using Discord.WebSocket;
using Discord.Commands;
public class Program

View File

@@ -1,5 +1,6 @@
using Discord;
using Discord.Commands;
using Discord.WebSocket;
public class Commands
{

View File

@@ -1,5 +1,6 @@
using Discord;
using Discord.Commands;
using Discord.WebSocket;
[Module]
public class ModuleA

View File

@@ -0,0 +1,5 @@
public async Task ChangeAvatar()
{
var fileStream = new FileStream("./newAvatar.png", FileMode.Open);
await (await _client.GetCurrentUserAsync()).ModifyAsync(x => x.Avatar = fileStream);
}

View File

@@ -0,0 +1,7 @@
public async Task SendMessageToChannel(ulong ChannelId)
{
var channel = await _client.GetChannelAsync(ChannelId) as IMessageChannel;
await channel?.SendMessageAsync("aaaaaaaaahhh!!!")
/* ^ This question mark is used to indicate that 'channel' may sometimes be null, and
in cases that it is null, we will do nothing here. */
}

View File

@@ -0,0 +1,8 @@
public async Task ModifyStatus()
{
await (await _client.GetCurrentUserAsync()).ModifyStatusAsync(x =>
{
x.Status = UserStatus.Idle;
x.Game = new Game("Type !help for help");
});
}

View File

@@ -1,4 +1,5 @@
using Discord;
using Discord.WebSocket;
class Program
{

View File

@@ -1,4 +1,5 @@
using Discord;
using Discord.Rest;
public class Program
{

View File

@@ -1,4 +1,5 @@
using Discord.Commands;
using Discord.WebSocket;
// Create a module with no prefix
[Module]

View File

@@ -6,4 +6,6 @@
- name: Logging
href: logging.md
- name: Commands
href: commands.md
href: commands.md
- name: FAQ
href: faq.md

View File

@@ -1,6 +1,6 @@
# Discord.Net Documentation
Refer to [Guides](guides/) for tutorials on using Discord.Net, or the [API documentation](api/) to review individual objects in the library.
Refer to [Guides](guides/intro.md) for tutorials on using Discord.Net, or the [API documentation](api/index.md) to review individual objects in the library.
**Todo:** Put something meaningful here.