Skip to content
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

Nested classes in System.Runtime.Intrinsics are missing xml doc comments #83165

Closed
tannergooding opened this issue Mar 8, 2023 · 10 comments · Fixed by #106091
Closed

Nested classes in System.Runtime.Intrinsics are missing xml doc comments #83165

tannergooding opened this issue Mar 8, 2023 · 10 comments · Fixed by #106091
Assignees
Labels
area-System.Runtime.Intrinsics documentation Documentation bug or enhancement, does not impact product or test code in-pr There is an active PR which will close this issue when it is merged
Milestone

Comments

@tannergooding
Copy link
Member

The various *.X64 and *.Arm64 nested classes in the System.Runtime.Intrinsics.* namespace are missing XML doc comments and should be updated to have them.

@tannergooding tannergooding added documentation Documentation bug or enhancement, does not impact product or test code area-System.Runtime.Intrinsics labels Mar 8, 2023
@tannergooding tannergooding self-assigned this Mar 8, 2023
@ghost ghost added the untriaged New issue has not been triaged by the area owner label Mar 8, 2023
@ghost
Copy link

ghost commented Mar 8, 2023

Tagging subscribers to this area: @dotnet/area-system-runtime-intrinsics
See info in area-owners.md if you want to be subscribed.

Issue Details

The various *.X64 and *.Arm64 nested classes in the System.Runtime.Intrinsics.* namespace are missing XML doc comments and should be updated to have them.

Author: tannergooding
Assignees: tannergooding
Labels:

documentation, area-System.Runtime.Intrinsics

Milestone: -

@tannergooding
Copy link
Member Author

CC. @carlossanlop, I don't remember seeing a warning about these ones in the tool back when we did the pass over what was missing docs.

@carlossanlop
Copy link
Member

Let me check. These assemblies might be affected by the issue I'm trying to fix with #82554

@tannergooding tannergooding removed the untriaged New issue has not been triaged by the area owner label Mar 10, 2023
@jeffhandley jeffhandley added this to the 9.0.0 milestone Jul 27, 2024
@michaelgsharp
Copy link
Member

@carlossanlop did you ever end up checking?

@michaelgsharp
Copy link
Member

Nevermind, I just did and it looks like they are still missing.

@carlossanlop
Copy link
Member

Can you please remind me if this was a problem in the compiled xml intellisense files, or if is this a problem in the porting tool?

@michaelgsharp
Copy link
Member

@tannergooding do you remember?

@carlossanlop
Copy link
Member

Nevermind, I just did and it looks like they are still missing.

What did you check here?

@michaelgsharp
Copy link
Member

I just went to the docs repo and checked for the various xml/ns-System.Runtime.Intrinsics.*.xml files and they are still missing. Unless they won't have their own files, but even the main xml/ns-System.Runtime.Intrinsics.xml is missing info about them.

@dotnet-policy-service dotnet-policy-service bot added the in-pr There is an active PR which will close this issue when it is merged label Aug 7, 2024
@tannergooding
Copy link
Member Author

This was an issue in that they never had XML documents added in the first place.

@github-actions github-actions bot locked and limited conversation to collaborators Sep 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Runtime.Intrinsics documentation Documentation bug or enhancement, does not impact product or test code in-pr There is an active PR which will close this issue when it is merged
Projects
None yet
4 participants