Merge pull request #1 from Chris-Johnston/better-documentation-for-quotation-mark-aliases

Improve XML docs for commands quotation mark aliases feature

src/Discord.Net.Commands/CommandServiceConfig.cs

@@ -34,8 +34,25 @@ namespace Discord.Commands
         /// </summary>
         public bool ThrowOnError { get; set; } = true;
 
-        /// <summary> Collection of aliases that can wrap strings for command parsing. 
-        /// represents the opening quotation mark and the value is the corresponding closing mark.</summary>
+        /// <summary>
+        /// Collection of aliases for matching pairs of string delimiters.
+        /// The dictionary stores the opening delimiter as a key, and the matching closing delimiter as the value.
+        /// If no value is supplied <see cref="QuotationAliasUtils.GetDefaultAliasMap"/> will be used, which contains
+        /// many regional equivalents.
+        /// Only values that are specified in this map will be used as string delimiters, so if " is removed then
+        /// it won't be used.
+        /// If this map is set to null or empty, the default delimiter of " will be used.
+        /// </summary>
+        /// <example>
+        /// <code language="C#">
+        /// QuotationMarkAliasMap = new Dictionary&lt;char, char%gt;()
+        /// {
+        ///     {'\"', '\"' },
+        ///     {'“', '”' },
+        ///     {'「', '」' },
+        /// }
+        /// </code>
+        /// </example>
         public Dictionary<char, char> QuotationMarkAliasMap { get; set; } = QuotationAliasUtils.GetDefaultAliasMap;
 
         /// <summary> Determines whether extra parameters should be ignored. </summary>

src/Discord.Net.Commands/Utilities/QuotationAliasUtils.cs

@@ -6,14 +6,16 @@ using System.Globalization;
 namespace Discord.Commands
 {
     /// <summary>
-    /// Utility methods for generating matching pairs of unicode quotation marks for CommandServiceConfig
+    /// Utility class which contains the default matching pairs of quotation marks for CommandServiceConfig
     /// </summary>
     internal static class QuotationAliasUtils
     {
         /// <summary>
-        /// Generates an IEnumerable of characters representing open-close pairs of
-        /// quotation punctuation.
+        /// A default map of open-close pairs of quotation marks.
+        /// Contains many regional and Unicode equivalents.
+        /// Used in the <see cref="CommandServiceConfig"/>.
         /// </summary>
+        /// <seealso cref="CommandServiceConfig.QuotationMarkAliasMap"/>
         internal static Dictionary<char, char> GetDefaultAliasMap
         {
             get