Add some xml comments #88433
Add some xml comments #88433
Conversation
dotnet-issue-labeler
bot
added
the
needs-area-label
teo-tsirpanis
added
area-Meta
and removed
needs-area-label
|
Tagging subscribers to this area: @dotnet/area-meta Issue DetailsMostly with regex, then I ended up replacing the text with what's in the docs so they can sync one day. There are still ~100 more files with the old style comments (and many more that don't have XML comments that match the docs) .. perhaps someone in the community is interested in doing more.
|
src/libraries/System.Private.CoreLib/src/System/ArrayTypeMismatchException.cs
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/BadImageFormatException.cs
Show resolved
Hide resolved
|
OK, done most of the rest. (Not sure why.) |
|
@carlossanlop would you perhaps have a few mins to sign off? what is the state of your tool/script for porting doc comments into sources? are there working instructions? perhaps I could push this a long a bit at a time in corelib, during coffee breaks so to speak, and do whatever manual fixups as we go. In a few cases the code comment may be better, but I'm guessing that's not many. then we'd slowly be progressing towards sources as doc sourceoftruth. |
There was a problem hiding this comment.
Thanks for tagging me @danmoseley . Left a bunch of suggestions for you to consider.
The backporting tool (dotnet-api-docs to runtime) isn't fully working yet, but the other one is (runtime to dotnet-api-docs).
...ibraries/System.Collections.Specialized/src/System/Collections/Specialized/ListDictionary.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/ApplicationException.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/ArgumentNullException.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/NotImplementedException.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/NullReferenceException.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Resources/FastResourceComparer.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Resources/ManifestBasedResourceGroveler.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Resources/ManifestBasedResourceGroveler.cs
Outdated
Show resolved
Hide resolved
|
I'm most interested in this direction. I'd be happy to try a flaky/partial tool if you like, worst case I can't use the results. |
Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
…festBasedResourceGroveler.cs Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
…ception.cs Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
|
all feedback addressed |
ghost
locked as resolved and limited conversation to collaborators
Mostly with regex, then I ended up replacing the text with what's in the docs so they can sync one day.
There are still ~100 more files with the old style comments (and many more that don't have XML comments that match the docs) .. perhaps someone in the community is interested in doing more.