Merge pull request #60 from lijunle/fix-typo

Fix typo in this project.

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "ms-vscode.csharp",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+  "cSpell.words": [
+    "junle",
+    "langword",
+    "linq",
+    "paramref",
+    "seealso",
+    "seealsos",
+    "typeparam",
+    "vsxmd"
+  ]
+}

Vsxmd/IConverter.cs

@@ -7,7 +7,7 @@
 namespace Vsxmd
 {
     /// <summary>
-    /// Converter for XML docuement to Markdown syntax conversion.
+    /// Converter for XML document to Markdown syntax conversion.
     /// </summary>
     public interface IConverter
     {

Vsxmd/Program.cs

@@ -100,7 +100,7 @@ internal Test()
             /// <para>See <see cref="TestGenericParameter{T1, T2}(Expression{Func{T1, T2, string}})"/>.</para>
             /// </summary>
             /// <returns>Nothing.</returns>
-            internal string TestGenericRefence() => null;
+            internal string TestGenericReference() => null;
 
             /// <summary>
             /// Test generic parameter type.

Vsxmd/Units/ExampleUnit.cs

@@ -36,7 +36,7 @@ public override IEnumerable<string> ToMarkdown() =>
 
         /// <summary>
         /// Convert the example XML element to Markdown safely.
-        /// If elemnt is <value>null</value>, return empty string.
+        /// If element is <value>null</value>, return empty string.
         /// </summary>
         /// <param name="element">The example XML element.</param>
         /// <returns>The generated Markdown.</returns>

Vsxmd/Units/ExceptionUnit.cs

@@ -39,7 +39,7 @@ public override IEnumerable<string> ToMarkdown() =>
 
         /// <summary>
         /// Convert the exception XML element to Markdown safely.
-        /// If elemnt is <value>null</value>, return empty string.
+        /// If element is <value>null</value>, return empty string.
         /// </summary>
         /// <param name="elements">The exception XML element list.</param>
         /// <returns>The generated Markdown.</returns>

Vsxmd/Units/Extensions.cs

@@ -86,7 +86,7 @@ internal static string ToReferenceLink(this string memberName, bool useShortName
         /// <para>The backtick characters inside the <paramref name="code"/> reverse as it is.</para>
         /// </summary>
         /// <param name="code">The code span.</param>
-        /// <returns>The Markdwon code span.</returns>
+        /// <returns>The Markdown code span.</returns>
         /// <remarks>Reference: http://meta.stackexchange.com/questions/55437/how-can-the-backtick-character-be-included-in-code .</remarks>
         internal static string AsCode(this string code)
         {
@@ -129,7 +129,7 @@ internal static IEnumerable<TSource> TakeAllButLast<TSource>(
         /// For example, it works for <c>summary</c> and <c>returns</c> elements.
         /// </summary>
         /// <param name="element">The XML element.</param>
-        /// <returns>The generated Markdwon content.</returns>
+        /// <returns>The generated Markdown content.</returns>
         /// <example>
         /// This method converts the following <c>summary</c> element.
         /// <code>

Vsxmd/Units/ParamUnit.cs

@@ -22,7 +22,7 @@ internal class ParamUnit : BaseUnit
         /// Initializes a new instance of the <see cref="ParamUnit"/> class.
         /// </summary>
         /// <param name="element">The param XML element.</param>
-        /// <param name="paramType">The paramter type corresponding to the param XML element.</param>
+        /// <param name="paramType">The parameter type corresponding to the param XML element.</param>
         /// <exception cref="ArgumentException">Throw if XML element name is not <c>param</c>.</exception>
         internal ParamUnit(XElement element, string paramType)
             : base(element, "param")

Vsxmd/Units/PermissionUnit.cs

@@ -39,7 +39,7 @@ public override IEnumerable<string> ToMarkdown() =>
 
         /// <summary>
         /// Convert the permission XML element to Markdown safely.
-        /// If elemnt is <value>null</value>, return empty string.
+        /// If element is <value>null</value>, return empty string.
         /// </summary>
         /// <param name="elements">The permission XML element list.</param>
         /// <returns>The generated Markdown.</returns>

Vsxmd/Units/RemarksUnit.cs

@@ -36,7 +36,7 @@ public override IEnumerable<string> ToMarkdown() =>
 
         /// <summary>
         /// Convert the remarks XML element to Markdown safely.
-        /// If elemnt is <value>null</value>, return empty string.
+        /// If element is <value>null</value>, return empty string.
         /// </summary>
         /// <param name="element">The remarks XML element.</param>
         /// <returns>The generated Markdown.</returns>

Vsxmd/Units/ReturnsUnit.cs

@@ -36,7 +36,7 @@ public override IEnumerable<string> ToMarkdown() =>
 
         /// <summary>
         /// Convert the returns XML element to Markdown safely.
-        /// If elemnt is <value>null</value>, return empty string.
+        /// If element is <value>null</value>, return empty string.
         /// </summary>
         /// <param name="element">The returns XML element.</param>
         /// <returns>The generated Markdown.</returns>

Vsxmd/Units/SeealsoUnit.cs

@@ -35,7 +35,7 @@ public override IEnumerable<string> ToMarkdown() =>
 
         /// <summary>
         /// Convert the seealso XML element to Markdown safely.
-        /// If elemnt is <value>null</value>, return empty string.
+        /// If element is <value>null</value>, return empty string.
         /// </summary>
         /// <param name="elements">The seealso XML element list.</param>
         /// <returns>The generated Markdown.</returns>

Vsxmd/Units/SummaryUnit.cs

@@ -36,7 +36,7 @@ public override IEnumerable<string> ToMarkdown() =>
 
         /// <summary>
         /// Convert the summary XML element to Markdown safely.
-        /// If elemnt is <value>null</value>, return empty string.
+        /// If element is <value>null</value>, return empty string.
         /// </summary>
         /// <param name="element">The summary XML element.</param>
         /// <returns>The generated Markdown.</returns>

Vsxmd/Units/TypeparamUnit.cs

@@ -39,7 +39,7 @@ public override IEnumerable<string> ToMarkdown() =>
 
         /// <summary>
         /// Convert the param XML element to Markdown safely.
-        /// If elemnt is <value>null</value>, return empty string.
+        /// If element is <value>null</value>, return empty string.
         /// </summary>
         /// <param name="elements">The param XML element list.</param>
         /// <returns>The generated Markdown.</returns>

Vsxmd/Vsxmd.csproj

@@ -18,7 +18,6 @@
     </PackageReference>
     <AdditionalFiles Include="stylecop.json" />
   </ItemGroup>
-
   <!-- NuGet Metadata: https://docs.microsoft.com/en-us/dotnet/core/tools/csproj#nuget-metadata-properties -->
   <PropertyGroup>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
@@ -49,7 +48,6 @@
       <_BuildOutputInPackage Remove="$(MSBuildProjectDirectory)\**\$(DocumentationFile)" />
     </ItemGroup>
   </Target>
-
   <!-- Generate the Markdown file for itself -->
   <Target Name="VsxmdPreparation" AfterTargets="PostBuildEvent">
     <PropertyGroup>

Vsxmd/Vsxmd.md

@@ -106,7 +106,7 @@
   - [TestGenericException()](#M-Vsxmd-Program-Test-TestGenericException 'Vsxmd.Program.Test.TestGenericException')
   - [TestGenericParameter\`\`2(expression)](#M-Vsxmd-Program-Test-TestGenericParameter``2-System-Linq-Expressions-Expression{System-Func{``0,``1,System-String}}- 'Vsxmd.Program.Test.TestGenericParameter``2(System.Linq.Expressions.Expression{System.Func{``0,``1,System.String}})')
   - [TestGenericPermission()](#M-Vsxmd-Program-Test-TestGenericPermission 'Vsxmd.Program.Test.TestGenericPermission')
-  - [TestGenericRefence()](#M-Vsxmd-Program-Test-TestGenericRefence 'Vsxmd.Program.Test.TestGenericRefence')
+  - [TestGenericReference()](#M-Vsxmd-Program-Test-TestGenericReference 'Vsxmd.Program.Test.TestGenericReference')
   - [TestParamWithoutDescription(p)](#M-Vsxmd-Program-Test-TestParamWithoutDescription-System-String- 'Vsxmd.Program.Test.TestParamWithoutDescription(System.String)')
   - [TestSeeLangword()](#M-Vsxmd-Program-Test-TestSeeLangword 'Vsxmd.Program.Test.TestSeeLangword')
 - [TestGenericType\`2](#T-Vsxmd-Program-TestGenericType`2 'Vsxmd.Program.TestGenericType`2')
@@ -364,7 +364,7 @@ This method has no parameters.
 ##### Summary
 
 Convert the example XML element to Markdown safely.
-If elemnt is `null`, return empty string.
+If element is `null`, return empty string.
 
 ##### Returns
 
@@ -423,7 +423,7 @@ This method has no parameters.
 ##### Summary
 
 Convert the exception XML element to Markdown safely.
-If elemnt is `null`, return empty string.
+If element is `null`, return empty string.
 
 ##### Returns
 
@@ -457,7 +457,7 @@ The backtick characters inside the `code`reverse as it is.
 
 ##### Returns
 
-The Markdwon code span.
+The Markdown code span.
 
 ##### Parameters
 
@@ -631,7 +631,7 @@ For example, it works for `summary`and `returns`elements.
 
 ##### Returns
 
-The generated Markdwon content.
+The generated Markdown content.
 
 ##### Parameters
 
@@ -686,7 +686,7 @@ Vsxmd
 
 ##### Summary
 
-Converter for XML docuement to Markdown syntax conversion.
+Converter for XML document to Markdown syntax conversion.
 
 <a name='M-Vsxmd-IConverter-ToMarkdown'></a>
 ### ToMarkdown() `method`
@@ -1058,7 +1058,7 @@ Initializes a new instance of the [ParamUnit](#T-Vsxmd-Units-ParamUnit 'Vsxmd.Un
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | element | [System.Xml.Linq.XElement](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Xml.Linq.XElement 'System.Xml.Linq.XElement') | The param XML element. |
-| paramType | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The paramter type corresponding to the param XML element. |
+| paramType | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The parameter type corresponding to the param XML element. |
 
 ##### Exceptions
 
@@ -1151,7 +1151,7 @@ This method has no parameters.
 ##### Summary
 
 Convert the permission XML element to Markdown safely.
-If elemnt is `null`, return empty string.
+If element is `null`, return empty string.
 
 ##### Returns
 
@@ -1250,7 +1250,7 @@ This method has no parameters.
 ##### Summary
 
 Convert the remarks XML element to Markdown safely.
-If elemnt is `null`, return empty string.
+If element is `null`, return empty string.
 
 ##### Returns
 
@@ -1309,7 +1309,7 @@ This method has no parameters.
 ##### Summary
 
 Convert the returns XML element to Markdown safely.
-If elemnt is `null`, return empty string.
+If element is `null`, return empty string.
 
 ##### Returns
 
@@ -1368,7 +1368,7 @@ This method has no parameters.
 ##### Summary
 
 Convert the seealso XML element to Markdown safely.
-If elemnt is `null`, return empty string.
+If element is `null`, return empty string.
 
 ##### Returns
 
@@ -1427,7 +1427,7 @@ This method has no parameters.
 ##### Summary
 
 Convert the summary XML element to Markdown safely.
-If elemnt is `null`, return empty string.
+If element is `null`, return empty string.
 
 ##### Returns
 
@@ -1604,8 +1604,8 @@ This method has no parameters.
 | ---- | ----------- |
 | [Vsxmd.Program.Test.TestGenericParameter\`\`2](#M-Vsxmd-Program-Test-TestGenericParameter``2-System-Linq-Expressions-Expression{System-Func{``0,``1,System-String}}- 'Vsxmd.Program.Test.TestGenericParameter``2(System.Linq.Expressions.Expression{System.Func{``0,``1,System.String}})') | Just for test. |
 
-<a name='M-Vsxmd-Program-Test-TestGenericRefence'></a>
-### TestGenericRefence() `method`
+<a name='M-Vsxmd-Program-Test-TestGenericReference'></a>
+### TestGenericReference() `method`
 
 ##### Summary
 
@@ -1744,7 +1744,7 @@ This method has no parameters.
 ##### Summary
 
 Convert the param XML element to Markdown safely.
-If elemnt is `null`, return empty string.
+If element is `null`, return empty string.
 
 ##### Returns