Skip to content

index.md

Latest commit

 

History

History
33 lines (23 loc) · 1.33 KB

index.md

File metadata and controls

33 lines (23 loc) · 1.33 KB
Raw

API Reference

The API pages under this section are generated by DocFX from the XML documentation comments emitted by FolderDiffIL4DotNet.csproj and FolderDiffIL4DotNet.Core.csproj.

Typical refresh flow:

dotnet build FolderDiffIL4DotNet.sln --configuration Release
dotnet tool update --global docfx --version '2.*'
export PATH="$PATH:$HOME/.dotnet/tools"
docfx metadata docfx.json
docfx build docfx.json

After generation, open _site/index.html locally or inspect the DocumentationSite artifact from GitHub Actions.

API リファレンス

このセクション配下の API ページは、FolderDiffIL4DotNet.csproj と FolderDiffIL4DotNet.Core.csproj が出力する XML ドキュメントコメントを DocFX で取り込んで自動生成します。

更新手順の例:

dotnet build FolderDiffIL4DotNet.sln --configuration Release
dotnet tool update --global docfx --version '2.*'
export PATH="$PATH:$HOME/.dotnet/tools"
docfx metadata docfx.json
docfx build docfx.json

生成後はローカルの _site/index.html を開くか、GitHub Actions の DocumentationSite artifact を確認してください。