diff options
| author | Leitwolf | 2026-10-03 18:46:55 +0300 |
|---|---|---|
| committer | GitHub | 2026-10-03 18:46:55 +0300 |
| commit | cf444eb3bccf99c10f59ed5330b61c0397e0aeaa (patch) | |
| tree | 5012d38d7dfc1bdc4cf75c3db7772d3fac7a5a4e /docs/api/filterConfig.yml | |
| parent | bc1b0b080b398e52b3201034f92398750f415ed2 (diff) | |
| parent | 08a076a3f880764462410a0b2f855d5bdfba1066 (diff) | |
| download | progmaweb-cf444eb3bccf99c10f59ed5330b61c0397e0aeaa.tar.gz | |
Merge pull request #26 from Progmasoft/ci/docfx-require-documentation
Require documentation for every item of the API reference
Diffstat (limited to 'docs/api/filterConfig.yml')
| -rw-r--r-- | docs/api/filterConfig.yml | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/api/filterConfig.yml b/docs/api/filterConfig.yml new file mode 100644 index 0000000..5b7b327 --- /dev/null +++ b/docs/api/filterConfig.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> +# SPDX-License-Identifier: AGPL-3.0-or-later WITH AdditionRef-Progmasoft-Patent-Grant-1.1 + +# Code that a source generator writes at build time is not part of the +# reference: nobody maintains it, and it cannot carry documentation. +apiRules: + - exclude: + uidRegex: ^System\.Text\.RegularExpressions\.Generated + # The regular-expression generator also writes the body of this partial + # method, and its generated comment replaces the one on the declaration, so + # the summary in the source never reaches the reference. + - exclude: + uidRegex: ^Progmasoft\.Progmaweb\.Api\.Accounts\.AccountNamePolicy\.CanonicalPattern$ + type: Method |