From b5425e96607da142cb46dcd4640d0e05daacf048 Mon Sep 17 00:00:00 2001
From: SubZero0 <pnmanjos@hotmail.com>
Date: Fri, 26 Jun 2020 17:00:46 -0300
Subject: [PATCH] Add example and fix param reference

---
 src/Discord.Net.Commands/CommandService.cs    |  9 ++++--
 .../Commands/CommandService.Examples.cs       | 32 +++++++++++++++++++
 .../Discord.Net.Examples.csproj               |  1 +
 3 files changed, 40 insertions(+), 2 deletions(-)
 create mode 100644 src/Discord.Net.Examples/Commands/CommandService.Examples.cs

diff --git a/src/Discord.Net.Commands/CommandService.cs b/src/Discord.Net.Commands/CommandService.cs
index ff392179e..80f9e5ce3 100644
--- a/src/Discord.Net.Commands/CommandService.cs
+++ b/src/Discord.Net.Commands/CommandService.cs
@@ -367,8 +367,13 @@ namespace Discord.Commands
         ///     Adds a custom entity <see cref="TypeReader" /> to this <see cref="CommandService" /> for the supplied
         ///     object type.
         /// </summary>
+        /// <example>
+        ///     <para>The following example adds a custom entity reader to this <see cref="CommandService"/>.</para>
+        ///     <code language="cs" region="AddEntityTypeReader"
+        ///           source="..\..\..\Discord.Net.Examples\Commands\CommandService.Examples.cs" />
+        /// </example>
         /// <typeparam name="T">The object type to be read by the <see cref="TypeReader"/>.</typeparam>
-        /// <param name="typeReaderType">
+        /// <param name="typeReaderGenericType">
         ///     A <see cref="Type" /> that is a generic type definition with a single open argument
         ///     of the <see cref="TypeReader" /> to be added.
         /// </param>
@@ -379,7 +384,7 @@ namespace Discord.Commands
         ///     object type.
         /// </summary>
         /// <param name="type">A <see cref="Type" /> instance for the type to be read.</param>
-        /// <param name="typeReaderType">
+        /// <param name="typeReaderGenericType">
         ///     A <see cref="Type" /> that is a generic type definition with a single open argument
         ///     of the <see cref="TypeReader" /> to be added.
         /// </param>
diff --git a/src/Discord.Net.Examples/Commands/CommandService.Examples.cs b/src/Discord.Net.Examples/Commands/CommandService.Examples.cs
new file mode 100644
index 000000000..add383fc2
--- /dev/null
+++ b/src/Discord.Net.Examples/Commands/CommandService.Examples.cs
@@ -0,0 +1,32 @@
+using Discord.Commands;
+using JetBrains.Annotations;
+using System;
+using System.Threading.Tasks;
+
+namespace Discord.Net.Examples.Commands
+{
+    [PublicAPI]
+    internal class CommandServiceExamples
+    {
+        #region AddEntityTypeReader
+
+        public void AddCustomEntityReader(CommandService commandService)
+        {
+            commandService.AddEntityTypeReader<IUser>(typeof(MyUserTypeReader<>));
+        }
+
+        public class MyUserTypeReader<T> : TypeReader
+            where T : class, IUser
+        {
+            public override async Task<TypeReaderResult> ReadAsync(ICommandContext context, string input, IServiceProvider services)
+            {
+                if (ulong.TryParse(input, out var id))
+                    return ((await context.Client.GetUserAsync(id)) is T user)
+                        ? TypeReaderResult.FromSuccess(user)
+                        : TypeReaderResult.FromError(CommandError.ObjectNotFound, "User not found.");
+                return TypeReaderResult.FromError(CommandError.ParseFailed, "Couldn't parse input to ulong.");
+            }
+
+        #endregion
+    }
+}
diff --git a/src/Discord.Net.Examples/Discord.Net.Examples.csproj b/src/Discord.Net.Examples/Discord.Net.Examples.csproj
index ec0253428..1f459f2e6 100644
--- a/src/Discord.Net.Examples/Discord.Net.Examples.csproj
+++ b/src/Discord.Net.Examples/Discord.Net.Examples.csproj
@@ -13,6 +13,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\Discord.Net.Commands\Discord.Net.Commands.csproj" />
     <ProjectReference Include="..\Discord.Net.Core\Discord.Net.Core.csproj" />
     <ProjectReference Include="..\Discord.Net.WebSocket\Discord.Net.WebSocket.csproj" />
     <PackageReference Include="JetBrains.Annotations" Version="2019.1.3" />