Documentation Overhaul (#1161)

* Add XML docs * Clean up style switcher * Squash commits on branch docs/faq-n-patches * Fix broken theme selector * Add local image embed instruction * Add a bunch of XML docs * Add a bunch of XML docs * Fix broken search + DocFX by default ships with an older version of jQuery, switching to a newer version confuses parts of the DocFX Javascript. * Minor fixes for CONTRIBUTING.md and README.md * Clean up filterConfig.yml + New config exposes Discord.Net namespace since it has several common public exceptions that may be helpful to users * Add XML docs * Read token from Environment Variable instead of hardcode * Add XMLDocs * Compress some assets & add OAuth2 URL generator * Fix sample link & add missing pictures * Add tag examples * Fix embed docs consistency * Add details regarding userbot support * Add XML Docs * Add XML Docs * Add XML Docs * Minor fixes in documentations + Fix unescaped '<' + Fix typo * Fix seealso for preconditions and add missing descriptions * Add missing exceptions * Document exposed TypeReaders * Fix letter-casing for files * Add 'last modified' plugin Source: https://github.com/Still34/DocFx.Plugin.LastModified Licensed under MIT License * XML Docs * Fix minor consistencies & redundant impl * Add properties examples to overwrite * Fix missing Username prop * Add warning for bulk-delete endpoint * Replace note block * Add BaseSocketClient docs * Add XML docs * Replace langword null to code block null instead - Because DocFX sucks at rendering langword * Replace all langword placements with code block * Add more IGuild docs * Add details to SpotifyGame * Initial proofread of the articles * Add explanation for RunMode * Add event docs - MessageReceived - ChannelUpdated/Destroyed/Created * Fix light theme link color * Fix xml docs error * Add partial documentation for audit log impl * Add documentation for some REST-based objects * Add partial documentation for audit log objects * Add more XML comments to quotation mark alias map stuff, including an example * Add reference to CommandServiceConfig from the util docs' * Add explanation that if " is removed then it wont work * Fix missing service provider in example * Add documentation for new INestedChannel * Add documentation * Add documentation for new API version & few events * Revise guide paragraphs/samples + Fix various formatting. + Provide a more detailed walkthrough for dependency injection. + Add C# note at intro. * Fix typos & formatting * Improve group module example * Small amount to see if I'm doing it right * Remove/cleanup redundant variables * Fix EnterTypingState impl for doc inheritance * Fix Test to resolve changes made in 15b58e * Improve precondition documentation + Add precondition usage sample + Add precondition group usage sample + Move precondition samples to its own sample folder * Move samples to individual folders * Clarify token source * Cleanup styling of README.md for docs * Replace InvalidPathChars for NS1.3 * InvalidPathChars does not exist in NS1.3; replaced with GetInvalidPathChars instead. * Add a missing change for 2c7cc738 * Update LastModified to v1.1.0 & add license * Rewrite installation page for Core 2.1 * Fix anchor link * Bump post-processor to v1.1.1 * Add fixes to partial file & add license * Moved theme-switcher code to scripts partial file + Add author's MIT license to featherlight javascript * Remove unused bootstrap plugin * Bump LastModified plugin * Changed the path from 'lastmodified' to 'last-modified' for consistency * Cleanup README & Contribution guide * Changes to last pr * Fix GetCategoryAsync docs * Proofread and cleanup articles * Change passive voice in "Get Started" to active * Fix improper preposition in Commands Introduction page * Fix minor grammar mistakes in "Your First Bot" (future tense -> present tense/subjunctive mood -> indicative mood/proper noun casing/incorrect noun/add missing article) * Fix minor grammar mistakes in "Installation" (missing article) * no hablo ingles * Try try try again * I'm sure you're having as much fun as I am * Cleanup TOC & fix titles * Improve styling + Change title font to Noto Sans + Add materialized design for commit message box * Add DescriptionGenerator plugin * Add nightly section for clarification * Fix typos in Nightlies & Post-execution * Bump DescriptionGenerator to v1.1.0 + This build adds the functionality of generating managed references' summary into the description tag. * Initial emoji article draft * Add 'additional information' section for emoji article * Add cosmetic changes to the master css * Alter info box color + Add transition to article content * Add clarification in the emoji article * Emphasize that normal emoji string will not translate to its Unicode representation. * Clean up or add some of the samples featured in the article. + Add emoji/emote declaration section for clarification. + Add WebSocket emote sample. - Remove inconsistent styling ('wacky memes' proves to be too out of place). * Improve readability for nightlies article * Move 'Bundled Preconditions' section * Bump LastModified to fix UTC DateTime parsing * Add langwordMapping.yml * Add XML docs * Add VSC workspace rule * The root workspace limits the ruler to 120 characters for member documentations and excludes folders such as 'samples' and 'docs'. * The docs workspace limits the ruler to 70 characters for standard conceptual article to comply with documentation's CONTRIBUTING.md rule, and excludes temprorary folders created by DocFX. * Update CONTRIBUTING.md * Add documentation style rule * Fix styling of several member documentation * Fix ' />' caused by Agent Smith oddities * Fix styling to be more specific about the mention of IDs * Fix exception summary to comply with official Microsoft Docs style * References https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception?view=netframework-4.7.2 https://docs.microsoft.com/en-us/dotnet/api/system.platformnotsupportedexception?view=netframework-4.7.2 https://docs.microsoft.com/en-us/dotnet/api/system.badimageformatexception?view=netframework-4.7.2 * Add XML documentations * Shift color return docs * Fix minor docs * Added documentation for SocketDMChannel, SocketGuildChannel, and SocketTextChannel * Add XML docs * Corrections to SocketGuildChannel * Corrections to SocketTextChannel * Corrections to SocketDMChannel * Swapped out 'id' for 'snowflake identifier * Swapped out 'id' for 'snowflake identifier' * SocketDMChannel amendments * SocketGuildChannel amendments * SocketTextChannel amendments * Add XML docs & patch return types + Starting from this commit, all return types for tasks will use style similar to most documentations featured on docs.microsoft.com References: https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext.-ctor?view=efcore-2.1 https://docs.microsoft.com/en-us/dotnet/api/system.io.filestream.readasync?view=netcore-2.1 https://docs.microsoft.com/en-us/dotnet/api/system.io.textwriter.writelineasync?view=netcore-2.1#System_IO_TextWriter_WriteLineAsync_System_Char___ And many more other asynchronous method documentations featured in the latest BCL. * Added documentation for many audit log data types, fixed vowel indefinite articles * Change audit log data types to start with 'Contains' (verb) instead of an article * Fix some documentation issues and document some more audit log data types * Fix English posession * Add XML doc * Documented two more types * Documented RoleCreateAuditLogData * Document remaining audit log data types * Added RestDMChannel documentation * Added RestGuildChannel documentation * Added RestTextChannel documentation * Added RestVoiceChannel documentation * Added RestUser documentation * Added RestRole documentation * Added RestMessage documentation * Slightly better wording * Contains -> Contains a piece of (describe article) * [EN] Present perf. -> past perf. * Add XML docs * Fix arrow alignment * Clarify supported nullable type * Fixed a typo in ISnowflakeEntity * Added RestUser Documentation * Added RestInvite documentation * Add XML docs & minor optimizations * Minor optimization for doc rendering * Rollback font optimization changes * Amendments to RestUser * Added SocketDMChannel documentation * Added RestDMChannel documentation * Added RestGuild documentation * Adjustment to SocketDMChannel * Added minimal descriptions from the API documentation for Integration types * Added obsolete mention to the ReadMessages flag. * Added remarks about 2FA requirement for guild permissions * Added xmldoc for GuildPermission methods * Added xml doc for ToAllowList and ToDenyList * Added specification of how the bits of the color raw value are packed * Added discord API documentation to IConnection interface * I can spell :^) * Fix whitespace in ChannelPermission * fix spacing of values in guildpermission * Made changes to get field descriptions from feedback, added returns tag to IConnection * Added property get standard for IntegrationAccount * Added property get pattern to xml docs and identical returns tag. * Change all color class references to struct ...because it isn't a class. * Add XML docs * Rewrote the returns tags in IGuildIntegration, removed the ones I was unsure about. * Rewrote the rest of the returns tags * Amendments * Cleanup doc for c1d78189 * Added types to <returns> tags where missing * Added second sample for adding reactions * Added some class summaries * Missed a period * Amendments * restored the removed line break * Removed unnecessary see tag * Use consistent quotation marks around subscribers, the name for these users are dependant on the source of where they are integrated from (youtube or twitch), so we should not use a name that is specific to one platform * Add <remarks> tag to the IGuildIntegration xmldocs * Fix grammar issue * Update DescriptionGenerator * Cleanup of https://github.com/Still34/Discord.Net/pull/8 * Cleanup previous PR * Fix for misleading behaviour in the emoji guide + Original lines stated that sending a emoji wrapped in colon will not be parsed, but that was incorrect; replaced with reactions instead of sending messages as the example * Add strings for dictionary in DotSettings * Add XML docs * Fix lots of typos in comments + Geez, I didn't know there were so many. * Add XML docs & rewrite GetMessagesAsync docs This commit rewrites the remarks section of GetMessagesAsync, as well as adding examples to several methods. * Update 'Your First Bot' + This commit reflects the new changes made to the Discord Application Developer Portal after its major update * Initial optimization for DocFX render & add missing files * Add examples in message methods * Cleanup https://github.com/RogueException/Discord.Net/pull/1128 * Fix first bot note * Cleanup FAQ structure * Add XML docs * Update docfx plugins * Fix navbar collapsing issue * Fix broken xref * Cleanup FAQ section + Add introductory paragraphs to each FAQ section. + Add 'missing dependency' entry to commands FAQ. * Split commands FAQ to 'General' and 'DI' sections. * Cleanup https://github.com/RogueException/Discord.Net/pull/1139 * Fix missing namespace * Add missing highlighting css for the light theme * Add additional clarification for installing packages * Add indentation to example for clarity * Cleanup several articles to be more human-friendly and easier to read * Remove RPC-related notes * Cleanup slow-mode-related documentation strings * Add an additional note about cross-guild emote usage * Add CreateTextChannel sample * Add XMLDocs
2018-10-01 05:44:33 +08:00
parent 6b21b11f7d
commit ff0fea98a6
498 changed files with 16064 additions and 2633 deletions
--- a/src/Discord.Net.Commands/Info/CommandInfo.cs
+++ b/src/Discord.Net.Commands/Info/CommandInfo.cs
@@ -8,10 +8,16 @@ using System.Linq;
 using System.Reflection;
 using System.Runtime.ExceptionServices;
 using System.Threading.Tasks;
-using Microsoft.Extensions.DependencyInjection;

 namespace Discord.Commands
 {
+    /// <summary>
+    ///     Provides the information of a command.
+    /// </summary>
+    /// <remarks>
+    ///     This object contains the information of a command. This can include the module of the command, various
+    ///     descriptions regarding the command, and its <see cref="RunMode"/>.
+    /// </remarks>
    [DebuggerDisplay("{Name,nq}")]
    public class CommandInfo
    {
@@ -21,18 +27,63 @@ namespace Discord.Commands
        private readonly CommandService _commandService;
        private readonly Func<ICommandContext, object[], IServiceProvider, CommandInfo, Task> _action;

+        /// <summary>
+        ///     Gets the module that the command belongs in.
+        /// </summary>
        public ModuleInfo Module { get; }
+        /// <summary>
+        ///     Gets the name of the command. If none is set, the first alias is used.
+        /// </summary>
        public string Name { get; }
+        /// <summary>
+        ///     Gets the summary of the command.
+        /// </summary>
+        /// <remarks>
+        ///     This field returns the summary of the command. <see cref="Summary"/> and <see cref="Remarks"/> can be
+        ///     useful in help commands and various implementation that fetches details of the command for the user.
+        /// </remarks>
        public string Summary { get; }
+        /// <summary>
+        ///     Gets the remarks of the command.
+        /// </summary>
+        /// <remarks>
+        ///     This field returns the summary of the command. <see cref="Summary"/> and <see cref="Remarks"/> can be
+        ///     useful in help commands and various implementation that fetches details of the command for the user.
+        /// </remarks>
        public string Remarks { get; }
+        /// <summary>
+        ///     Gets the priority of the command. This is used when there are multiple overloads of the command.
+        /// </summary>
        public int Priority { get; }
+        /// <summary>
+        ///     Indicates whether the command accepts a <see langword="params"/> <see cref="Type"/>[] for its
+        ///     parameter.
+        /// </summary>
        public bool HasVarArgs { get; }
+        /// <summary>
+        ///     Indicates whether extra arguments should be ignored for this command.
+        /// </summary>
        public bool IgnoreExtraArgs { get; }
+        /// <summary>
+        ///     Gets the <see cref="RunMode" /> that is being used for the command.
+        /// </summary>
        public RunMode RunMode { get; }

+        /// <summary>
+        ///     Gets a list of aliases defined by the <see cref="AliasAttribute" /> of the command.
+        /// </summary>
        public IReadOnlyList<string> Aliases { get; }
+        /// <summary>
+        ///     Gets a list of information about the parameters of the command.
+        /// </summary>
        public IReadOnlyList<ParameterInfo> Parameters { get; }
+        /// <summary>
+        ///     Gets a list of preconditions defined by the <see cref="PreconditionAttribute" /> of the command.
+        /// </summary>
        public IReadOnlyList<PreconditionAttribute> Preconditions { get; }
+        /// <summary>
+        ///     Gets a list of attributes of the command.
+        /// </summary>
        public IReadOnlyList<Attribute> Attributes { get; }

        internal CommandInfo(CommandBuilder builder, ModuleInfo module, CommandService service)
@@ -100,11 +151,11 @@ namespace Discord.Commands
                return PreconditionGroupResult.FromSuccess();
            }

-            var moduleResult = await CheckGroups(Module.Preconditions, "Module");
+            var moduleResult = await CheckGroups(Module.Preconditions, "Module").ConfigureAwait(false);
            if (!moduleResult.IsSuccess)
                return moduleResult;

-            var commandResult = await CheckGroups(Preconditions, "Command");
+            var commandResult = await CheckGroups(Preconditions, "Command").ConfigureAwait(false);
            if (!commandResult.IsSuccess)
                return commandResult;

@@ -124,7 +175,7 @@ namespace Discord.Commands

            return await CommandParser.ParseArgsAsync(this, context, _commandService._ignoreExtraArgs, services, input, 0, _commandService._quotationMarkAliasMap).ConfigureAwait(false);
        }
-
+        
        public Task<IResult> ExecuteAsync(ICommandContext context, ParseResult parseResult, IServiceProvider services)
        {
            if (!parseResult.IsSuccess)
@@ -248,11 +299,11 @@ namespace Discord.Commands
            foreach (object arg in argList)
            {
                if (i == argCount)
-                    throw new InvalidOperationException("Command was invoked with too many parameters");
+                    throw new InvalidOperationException("Command was invoked with too many parameters.");
                array[i++] = arg;
            }
            if (i < argCount)
-                throw new InvalidOperationException("Command was invoked with too few parameters");
+                throw new InvalidOperationException("Command was invoked with too few parameters.");

            if (HasVarArgs)
            {
--- a/src/Discord.Net.Commands/Info/ModuleInfo.cs
+++ b/src/Discord.Net.Commands/Info/ModuleInfo.cs
@@ -6,20 +6,59 @@ using Discord.Commands.Builders;

 namespace Discord.Commands
 {
+    /// <summary>
+    ///     Provides the information of a module.
+    /// </summary>
    public class ModuleInfo
    {
+        /// <summary>
+        ///     Gets the command service associated with this module.
+        /// </summary>
        public CommandService Service { get; }
+        /// <summary>
+        ///     Gets the name of this module.
+        /// </summary>
        public string Name { get; }
+        /// <summary>
+        ///     Gets the summary of this module.
+        /// </summary>
        public string Summary { get; }
+        /// <summary>
+        ///     Gets the remarks of this module.
+        /// </summary>
        public string Remarks { get; }
+        /// <summary>
+        ///     Gets the group name (main prefix) of this module.
+        /// </summary>
        public string Group { get; }

+        /// <summary>
+        ///     Gets a read-only list of aliases associated with this module.
+        /// </summary>
        public IReadOnlyList<string> Aliases { get; }
+        /// <summary>
+        ///     Gets a read-only list of commands associated with this module.
+        /// </summary>
        public IReadOnlyList<CommandInfo> Commands { get; }
+        /// <summary>
+        ///     Gets a read-only list of preconditions that apply to this module.
+        /// </summary>
        public IReadOnlyList<PreconditionAttribute> Preconditions { get; }
+        /// <summary>
+        ///     Gets a read-only list of attributes that apply to this module.
+        /// </summary>
        public IReadOnlyList<Attribute> Attributes { get; }
+        /// <summary>
+        ///     Gets a read-only list of submodules associated with this module.
+        /// </summary>
        public IReadOnlyList<ModuleInfo> Submodules { get; }
+        /// <summary>
+        ///     Gets the parent module of this submodule if applicable.
+        /// </summary>
        public ModuleInfo Parent { get; }
+        /// <summary>
+        ///     Gets a value that indicates whether this module is a submodule or not.
+        /// </summary>
        public bool IsSubmodule => Parent != null;

        internal ModuleInfo(ModuleBuilder builder, CommandService service, IServiceProvider services, ModuleInfo parent = null)
--- a/src/Discord.Net.Commands/Info/ParameterInfo.cs
+++ b/src/Discord.Net.Commands/Info/ParameterInfo.cs
@@ -2,25 +2,56 @@ using Discord.Commands.Builders;
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
+using System.Diagnostics;
 using System.Threading.Tasks;
-using Microsoft.Extensions.DependencyInjection;

 namespace Discord.Commands
 {
+    /// <summary>
+    ///     Provides the information of a parameter.
+    /// </summary>
+    [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
    public class ParameterInfo
    {
        private readonly TypeReader _reader;

+        /// <summary>
+        ///     Gets the command that associates with this parameter.
+        /// </summary>
        public CommandInfo Command { get; }
+        /// <summary>
+        ///     Gets the name of this parameter.
+        /// </summary>
        public string Name { get; }
+        /// <summary>
+        ///     Gets the summary of this parameter.
+        /// </summary>
        public string Summary { get; }
+        /// <summary>
+        ///     Gets a value that indicates whether this parameter is optional or not.
+        /// </summary>
        public bool IsOptional { get; }
+        /// <summary>
+        ///     Gets a value that indicates whether this parameter is a remainder parameter or not.
+        /// </summary>
        public bool IsRemainder { get; }
        public bool IsMultiple { get; }
+        /// <summary>
+        ///     Gets the type of the parameter.
+        /// </summary>
        public Type Type { get; }
+        /// <summary>
+        ///     Gets the default value for this optional parameter if applicable.
+        /// </summary>
        public object DefaultValue { get; }

+        /// <summary>
+        ///     Gets a read-only list of precondition that apply to this parameter.
+        /// </summary>
        public IReadOnlyList<ParameterPreconditionAttribute> Preconditions { get; }
+        /// <summary>
+        ///     Gets a read-only list of attributes that apply to this parameter.
+        /// </summary>
        public IReadOnlyList<Attribute> Attributes { get; }

        internal ParameterInfo(ParameterBuilder builder, CommandInfo command, CommandService service)
@@ -65,4 +96,4 @@ namespace Discord.Commands
        public override string ToString() => Name;
        private string DebuggerDisplay => $"{Name}{(IsOptional ? " (Optional)" : "")}{(IsRemainder ? " (Remainder)" : "")}";
    }
-}
+}