Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.87 KB

HowToGenerateDocumentation.md

File metadata and controls

45 lines (32 loc) · 1.87 KB
Raw

How to Generate API Documentation

  1. Install package Roslynator.CommandLine NuGet

  2. Add MSBuild Target to your csproj (vbproj) file

<Target Name="GenerateDocumentation" AfterTargets="RoslynatorInitialize" Condition=" '$(Configuration)' == 'Release'">

    <!-- Execute 'generate-doc' command. This command will generate documentation files -->
  <Exec Command="$(RoslynatorExe) generate-doc &quot;$(SolutionPath)&quot; ^
    --msbuild-path &quot;$(MSBuildBinPath)&quot; ^
    -o &quot;$(SolutionDir)docs&quot; ^
    -h &quot;API Reference&quot;"
        LogStandardErrorAsError="true" ConsoleToMSBuild="true">
    <Output TaskParameter="ConsoleOutput" PropertyName="OutputOfExec" />
  </Exec>

    <!-- Execute 'list-symbols' command. This command will generate list of symbol definitions -->
  <Exec Command="$(RoslynatorExe) list-symbols &quot;$(SolutionPath)&quot; ^
    --msbuild-path &quot;$(MSBuildBinPath)&quot; ^
    --output &quot;$(SolutionDir)docs\api.cs&quot; ^
	--visibility public"
        LogStandardErrorAsError="true" ConsoleToMSBuild="true">
    <Output TaskParameter="ConsoleOutput" PropertyName="OutputOfExec" />
  </Exec>

</Target>

Commands

  1. Build solution in Release configuration

  2. Publish documentation to GitHub

See Also