Skip to content

Add MA0197 to disallow inheritdoc on types#1138

Merged
meziantou merged 3 commits intomainfrom
meziantou/inheritdoc-rule-plan
May 7, 2026
Merged

Add MA0197 to disallow inheritdoc on types#1138
meziantou merged 3 commits intomainfrom
meziantou/inheritdoc-rule-plan

Conversation

@meziantou
Copy link
Copy Markdown
Owner

This adds a project-style rule for <inheritdoc> usage: allow it on members, but report it on type declarations.

The motivation is to enforce a members-only documentation inheritance style without changing MA0196's existing behavior.

What changed

  • Added MA0197 (InheritdocShouldNotBeUsedOnTypes) and implemented a new analyzer on SymbolKind.NamedType.
  • Kept MA0196 unchanged so it remains focused on non-inheriting members.
  • Added tests covering class/interface usage, partial declarations, member usage, and cref cases.
  • Added docs/Rules/MA0197.md and updated docs/comparison-with-other-analyzers.md.
  • Regenerated analyzer docs and packaged editorconfig files.

Notes for reviewers

  • This behavior is intentionally stricter than official <inheritdoc> guidance and stricter than SA1648 for inheriting types.
  • MA0197 reports type-level <inheritdoc> even when cref is present, by design for this style policy.

meziantou and others added 3 commits May 7, 2026 12:35
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@meziantou meziantou merged commit 6a1b0f5 into main May 7, 2026
13 checks passed
@meziantou meziantou deleted the meziantou/inheritdoc-rule-plan branch May 7, 2026 17:22
This was referenced May 7, 2026
This was referenced May 8, 2026
IhateTrains pushed a commit to ParadoxGameConverters/ImperatorToCK3 that referenced this pull request May 10, 2026
Updated
[Meziantou.Analyzer](https://github.com/meziantou/Meziantou.Analyzer)
from 3.0.72 to 3.0.74.

<details>
<summary>Release notes</summary>

_Sourced from [Meziantou.Analyzer's
releases](https://github.com/meziantou/Meziantou.Analyzer/releases)._

## 3.0.74

NuGet package:
<https://www.nuget.org/packages/Meziantou.Analyzer/3.0.74>

## What's Changed
* Add MA0197 to disallow inheritdoc on types by @​meziantou in
meziantou/Meziantou.Analyzer#1138


**Full Changelog**:
meziantou/Meziantou.Analyzer@3.0.73...3.0.74

## 3.0.73

NuGet package:
<https://www.nuget.org/packages/Meziantou.Analyzer/3.0.73>

## What's Changed
* Add MA0196 to flag invalid <inheritdoc /> usage by @​meziantou in
meziantou/Meziantou.Analyzer#1137


**Full Changelog**:
meziantou/Meziantou.Analyzer@3.0.72...3.0.73

Commits viewable in [compare
view](meziantou/Meziantou.Analyzer@3.0.72...3.0.74).
</details>

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Meziantou.Analyzer&package-manager=nuget&previous-version=3.0.72&new-version=3.0.74)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant