Remove TODO from public documentation

[Youssef1313]

Fixes #47366

There are more TODOs in triple-slash doc comments. But I only found this one in a public API.

[sharwell]

Rather than remove the semantic reference (the <see> element), you can change <remarks> to <devdoc> which continues to be validated by the compiler but doesn't show in rendered documentation.

[Youssef1313]

Rather than remove the semantic reference (the <see> element), you can change <remarks> to <devdoc> which continues to be validated by the compiler but doesn't show in rendered documentation.

Thanks. I didn't know about the existence of devdoc.

[sharwell]

I didn't know about the existence of devdoc.

It's a made-up XML element historically used for this purpose. The documentation compiler defines several well-known elements, but tools are allowed to define and/or use others.

[Youssef1313]

@sharwell I found that a devdoc was used in dotnet/runtime but was included in the public documentation:

https://github.com/dotnet/runtime/blob/6072e4d3a7a2a1493f514cdf4be75a3d56580e84/src/libraries/System.Diagnostics.Process/src/System/Diagnostics/ThreadWaitReason.cs#L6-L9

https://docs.microsoft.com/en-us/dotnet/api/system.diagnostics.threadwaitreason?view=netcore-3.1

The XML for the doc page include the exact same text as summary.

Any idea why this is happening? Was that a manual change to the generated XML?

[sharwell]

Here's the XML documentation for ThreadWaitReason:
https://github.com/dotnet/dotnet-api-docs/blob/78344cc2feabc5795757fe8770e7692c4f9d4211/xml/System.Diagnostics/ThreadWaitReason.xml#L80

The <devdoc> in dotnet/runtime is just for local reference but isn't the actual API documentation for this type.

[jcouv]

LGTM Thanks (iteration 3)

[jcouv]

Squashed/merged. Thanks @Youssef1313 !