Merge pull request #23 from sharwell/render-as-markdown

Implement DOC900 RenderAsMarkdown

Author: sharwell

DOCUMENTATION.md

@@ -6,4 +6,8 @@ DocumentationAnalyzers provides warnings that indicate documentation rule violat
 
 Rules related to the style of documentation comments.
 
+**[Refactorings (DOC900-)](docs/Refactorings.md)**
+
+Additional refactorings provided when the analyzer is installed.
+
 ### Additional documentation

DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/DocumentationAnalyzers.CodeFixes.csproj

@@ -3,6 +3,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>netstandard1.1;net452</TargetFrameworks>
+    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
     <RootNamespace>DocumentationAnalyzers</RootNamespace>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <IncludeSymbols>true</IncludeSymbols>
@@ -35,6 +36,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="1.2.1" />
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="1.2.1" />
+    <PackageReference Include="CommonMark.NET" Version="0.15.1" />
   </ItemGroup>
 
   <ItemGroup>

DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/DocumentationAnalyzers.nuspec

@@ -25,6 +25,9 @@
     <file src="bin\$Configuration$\netstandard1.1\**\DocumentationAnalyzers.CodeFixes.resources.dll" target="analyzers\dotnet\cs" />
     <file src="bin\$Configuration$\netstandard1.1\DocumentationAnalyzers.CodeFixes.pdb" target="analyzers\dotnet\cs" />
 
+    <!-- Dependencies -->
+    <file src="bin\$Configuration$\netstandard1.1\CommonMark.dll" target="analyzers\dotnet\cs" />
+
     <!-- Scripts -->
     <file src="tools\install.ps1" target="tools\" />
     <file src="tools\uninstall.ps1" target="tools\" />

DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/Helpers/XmlSyntaxFactory.cs

@@ -73,9 +73,9 @@ public static SyntaxList<XmlNodeSyntax> List(params XmlNodeSyntax[] nodes)
             return SyntaxFactory.List(nodes);
         }
 
-        public static XmlTextSyntax Text(string value)
+        public static XmlTextSyntax Text(string value, bool xmlEscape = true)
         {
-            return Text(TextLiteral(value));
+            return Text(TextLiteral(value, escapeQuotes: false, xmlEscape));
         }
 
         public static XmlTextSyntax Text(params SyntaxToken[] textTokens)
@@ -162,12 +162,12 @@ public static SyntaxToken TextNewLine(string text, bool continueComment)
 
         public static SyntaxToken TextLiteral(string value)
         {
-            return TextLiteral(value, false);
+            return TextLiteral(value, escapeQuotes: false);
         }
 
-        public static SyntaxToken TextLiteral(string value, bool escapeQuotes)
+        public static SyntaxToken TextLiteral(string value, bool escapeQuotes, bool xmlEscape = true)
         {
-            string encoded = new XText(value).ToString();
+            string encoded = xmlEscape ? new XText(value).ToString() : value;
             if (escapeQuotes)
             {
                 encoded = encoded.Replace("\"", "&quot;");