diff options
| author | Leitwolf11 | 2026-10-03 18:46:59 +0300 |
|---|---|---|
| committer | Leitwolf11 | 2026-10-03 18:46:59 +0300 |
| commit | b84a2216c26cc5392d0dc300b7a605ccb288d8c8 (patch) | |
| tree | 048ae623f49cc5f2f94234d747351f9e659f5267 /docs/DEVELOPMENT.md | |
| parent | ec774db15976385a6d5ea6f48d3622fe507d3843 (diff) | |
| parent | cf444eb3bccf99c10f59ed5330b61c0397e0aeaa (diff) | |
| download | progmaweb-fix/api-without-google.tar.gz | |
Merge remote-tracking branch 'origin/main' into fix/api-without-googlefix/api-without-google
Diffstat (limited to 'docs/DEVELOPMENT.md')
| -rw-r--r-- | docs/DEVELOPMENT.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index 608411f..022af77 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -118,11 +118,15 @@ version, so a local run and CI use the same tool. ```text dotnet tool restore dotnet docfx docs/api/docfx.json --warningsAsErrors +dotnet run docs/api/CheckDocumentation.cs -- docs/api ``` -or `just api-docs`. The output goes to `docs/api/_site`, which is ignored by Git. A broken link or an unresolved -reference fails the build. The gate does not yet require documentation comments on the C# declarations; see -[Known limitations](LIMITATIONS.md). +or `just api-docs`. The output goes to `docs/api/_site`, which is ignored by Git. + +The gate fails on a broken link or an unresolved reference, on a public declaration without a documentation comment, +and on any namespace, type or member of the reference that has no summary, internal and private ones included. A new +declaration therefore needs its `<summary>` in the same change. [The API reference page](api/index.md) describes the +three parts of the gate and how a namespace is described. ## Conventions |