Skip to content

Add MA0196 to flag invalid <inheritdoc /> usage#1137

Merged
meziantou merged 1 commit intomainfrom
meziantou/inheritdoc-rule
May 7, 2026
Merged

Add MA0196 to flag invalid <inheritdoc /> usage#1137
meziantou merged 1 commit intomainfrom
meziantou/inheritdoc-rule

Conversation

@meziantou
Copy link
Copy Markdown
Owner

Using <inheritdoc /> on members that do not inherit documentation can produce misleading API docs. This adds a dedicated rule to catch that case and keep XML comments accurate.

What changed

  • Added MA0196 (InheritdocShouldBeUsedOnInheritingMemberAnalyzer) to report <inheritdoc /> on method/property/event members that are neither overrides nor interface implementations.
  • Kept an explicit exemption when cref is present on <inheritdoc .../>.
  • Set the rule to warning severity and enabled by default.
  • Added analyzer tests for valid and invalid scenarios (override, interface implementation, explicit implementation, and cref exemption).
  • Added rule documentation (docs/Rules/MA0196.md), updated analyzer comparison docs, and regenerated generated README/editorconfig outputs.

Notes

  • No code fix is included for this rule.

Add MA0196 to report <inheritdoc /> usage on members that are not overrides or interface implementations, with an exemption when cref is provided. Include analyzer tests, rule docs, comparison mapping, and regenerated documentation/config outputs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@meziantou meziantou merged commit 0579dbe into main May 7, 2026
13 checks passed
@meziantou meziantou deleted the meziantou/inheritdoc-rule branch May 7, 2026 16:25
This was referenced May 7, 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>
This was referenced May 10, 2026
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