SA1625 (copied and pasted) and inheritdoc

[brinko99]

Regarding: 1.2.0-beta.113 (and earlier)

The below shows a violation of SA1625 on the second inheritdoc, due to inheritdoc also being used within the values param.

I believe this is a valid use case and should be allowed by SA1625.

Note, I tried removing the values param all together with the hope that the higher level inheritdoc would cover the missing param. But this produces a CS1573 warning (Parameter 'values' has no matching param tag in the XML comment for 'values' (but other parameters do)).

Might there be other ways to accomplish this?

Thanks.

/// <summary>
/// My summary text.
/// </summary>
/// <param name="values"><inheritdoc /></param>
/// <param name="targetType">The parameter is not used.</param>
/// <param name="parameter">The parameter is not used.</param>
/// <param name="culture">The parameter is not used.</param>>
/// <inheritdoc />

[sharwell]

But this produces a CS1573 warning

I recommend disabling the following three documentation warnings:

StyleCopAnalyzers/StyleCop.Analyzers/Directory.Build.props

Lines 29 to 38 in b15704e

	<!--
	Make sure any documentation comments which are included in code get checked for syntax during the build, but do
	not report warnings for missing comments.
	CS1573: Parameter 'parameter' has no matching param tag in the XML comment for 'parameter' (but other parameters do)
	CS1591: Missing XML comment for publicly visible type or member 'Type_or_Member'
	CS1712: Type parameter 'type_parameter' has no matching typeparam tag in the XML comment on 'type_or_member' (but other type parameters do)
	-->
	<GenerateDocumentationFile>True</GenerateDocumentationFile>
	<NoWarn>$(NoWarn),1573,1591,1712</NoWarn>

[sharwell]

I marked this as a bug because the documentation content rules should evaluate <inheritdoc/> rather than treating it as a literal. It will be nearly impossible to implement the rules today because command line builds currently fail to provide a documentation provider for referenced assemblies (dotnet/roslyn#23673).

[brinko99]

@sharwell, thanks for guidance.