steveharter / api-docs-sync

Tools for porting documentation from intellisense xmls to api-docs, or from api-docs to triple slash comments.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

API Docs Sync

This repo contains two tools that allow porting documentation in two directions:

  • IntelliSense xml files to MS Docs xml files. Instructions.

  • MS Docs xml files to triple slash comments in source code. Instructions.

Requirements

Install as dotnet tools

To install the two tools as global dotnet tools in your $PATH, run the install-as-tool.ps1 script.

Documentation for global dotnet tools: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install

Remember to update the tool periodically to collect the latest changes. Updating instructions: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-update

About

Tools for porting documentation from intellisense xmls to api-docs, or from api-docs to triple slash comments.

License:MIT License


Languages

Language:C# 99.8%Language:PowerShell 0.2%