You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/// <summary>/// Gets the content of the specified uri as a stream asynchronously./// </summary>/// <param name="uri">the request URI.</param>/// <returns>/// A <see cref="Task{TResult}"/> representing the result of the asynchronous operation./// </returns>/// <include file="docs.xml" path="/docs/CancellationToken/*"/>publicTask<Stream>GetContentAsync(Uriuri,CancellationTokencancellationToken=default){// [...]}
docs.xml
<?xml version="1.0" encoding="utf-8" ?>
<docs>
<CancellationToken>
<paramname="cancellationToken">
a cancellation token used to propagate notification that the asynchronous operation
should be canceled.
</param>
<exceptioncref="System.OperationCanceledException">
thrown if the cancellation token has had cancellation requested
</exception>
</CancellationToken>
</docs>
I think the analyzer should read the docs.xml file and include the documentation from it but instead, it shows a warning: warning SA1611: The documentation for parameter 'cancellationToken' is missing.
This issue only occurs when some of the parameters are documented in the included and some of the parameters are documented "above the method". IntelliSense recognizes the parameters even if they are documented in different places.
The code below produces a violation of SA1611 (ElementParametersMustBeDocumented):
Program.cs
docs.xml
I think the analyzer should read the
docs.xml
file and include the documentation from it but instead, it shows a warning:warning SA1611: The documentation for parameter 'cancellationToken' is missing.
This issue only occurs when some of the parameters are documented in the included and some of the parameters are documented "above the method". IntelliSense recognizes the parameters even if they are documented in different places.
I've also created a repository that shows how to reproduce the issue: https://github.com/angelobreuer/SA1611Repro
Thanks in advance!
The text was updated successfully, but these errors were encountered: