-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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.
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
Remove inheritdoc #6246
Remove inheritdoc #6246
Conversation
@@ -113,7 +113,6 @@ public sealed class RoslynCodeTaskFactory : ITaskFactory | |||
/// <inheritdoc cref="ITaskFactory.FactoryName"/> | |||
public string FactoryName => "Roslyn Code Task Factory"; | |||
|
|||
/// <inheritdoc /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 This was inheriting from
msbuild/src/Framework/ITaskFactory.cs
Lines 20 to 23 in 40beb5a
/// <summary> | |
/// Gets the type of the task this factory will instantiate. Implementations must return a value for this property. | |
/// </summary> | |
Type TaskType { get; } |
While it's perfectly valid to include both <inheritdoc/>
and other content, it only has an impact when the inherited documentation contains elements that are not manually replaced (e.g. if the inherited documentation had <remarks>
or <value>
, but this property only contained <summary>
.
@gewarren Can you verify that this:
Only applies to cases where the additional documentation fully replaces the inherited documentation? Partial replacement is a proper supported use case for |
Apparently it is not implemented that way in the docs build system. There is no partial replacement of doc comments through inheritdoc. cc @mimisasouvanh |
This property has both summary comments and inheritdoc. It causes a docs build warning to have both.
Contributes to dotnet/dotnet-api-docs#5411.