Skip to content

<inheritdoc/> should not be used on partial properties. #1176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
caverna wants to merge 2 commits into
base: main
Choose a base branch
from
+1 −17
Open

<inheritdoc/> should not be used on partial properties. #1176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97c1162
Update ObservablePropertyGenerator.Execute.cs
Apr 1, 2026
1dd9516
tests updated
Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...munityToolkit.Mvvm.SourceGenerators/ComponentModel/ObservablePropertyGenerator.Execute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1169,7 +1169,7 @@ public static MemberDeclarationSyntax GetPropertySyntax(PropertyInfo propertyInf
// - For partial properties, always just inherit from the partial declaration
// - For fields, inherit from them
string xmlSummary = propertyInfo.AnnotatedMemberKind is SyntaxKind.PropertyDeclaration
? "/// <inheritdoc/>"
? string.Empty
: $"/// <inheritdoc cref=\"{getterFieldIdentifierName}\"/>";

if (propertyInfo.NotifyPropertyChangedRecipients || propertyInfo.IsOldPropertyValueDirectlyReferenced)
Expand Down
16 changes: 0 additions & 16 deletions ...mmunityToolkit.Mvvm.SourceGenerators.Roslyn4120.UnitTests/Test_SourceGeneratorsCodegen.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
partial int Number
Expand Down Expand Up @@ -116,7 +115,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
partial int Number
Expand Down Expand Up @@ -192,7 +190,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public required partial int Number
Expand Down Expand Up @@ -272,7 +269,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public new partial int Number
Expand Down Expand Up @@ -346,7 +342,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public virtual partial int Number
Expand Down Expand Up @@ -427,7 +422,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public {{modifiers}} partial int Number
Expand Down Expand Up @@ -501,7 +495,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public partial int Number
Expand Down Expand Up @@ -575,7 +568,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
internal partial int Number
Expand Down Expand Up @@ -650,7 +642,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
protected internal partial string Name
Expand Down Expand Up @@ -726,7 +717,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public partial string Name
Expand Down Expand Up @@ -802,7 +792,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public partial string? Name
Expand Down Expand Up @@ -879,7 +868,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public partial string Name
Expand Down Expand Up @@ -959,7 +947,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public partial string Name
Expand Down Expand Up @@ -1036,7 +1023,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public partial string Name
Expand Down Expand Up @@ -1117,7 +1103,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public partial string Name
Expand Down Expand Up @@ -1175,7 +1160,6 @@ namespace MyApp
/// <inheritdoc/>
partial class MyViewModel
{
/// <inheritdoc/>
[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", <ASSEMBLY_VERSION>)]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public partial string Name
Expand Down