-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add missing xml docs for System.Runtime.Intrinsics #11930
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
base: main
Are you sure you want to change the base?
Conversation
Tagging subscribers to this area: @dotnet/area-system-runtime-intrinsics |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds and enriches missing XML documentation for System.Runtime.Intrinsics vector types (Vector64, Vector128, Vector256, Vector512) to address issue #120508.
- Replaces many placeholder "To be added." entries with meaningful summaries, type parameter, parameter, and returns descriptions.
- Adds references for constant properties and removes some inheritdoc tags where explicit docs are now provided.
- Introduces new remarks and exception tags, though a few contain grammatical and structural issues.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 13 comments.
File | Description |
---|---|
xml/System.Runtime.Intrinsics/Vector64.xml | Adds inheritdoc references for constant getters; enhances classification method docs. |
xml/System.Runtime.Intrinsics/Vector128.xml | Substantial expansion of summaries, parameters, returns, and exceptions; removes some inheritdoc tags. |
xml/System.Runtime.Intrinsics/Vector256.xml | Mirrors Vector64 constant inheritdoc additions and removes some inheritdoc tags. |
xml/System.Runtime.Intrinsics/Vector512.xml | Similar updates to Vector256 with inheritdoc additions and cleanup. |
Co-authored-by: Copilot <[email protected]>
-- GitHub seems to not like applying bulk suggestions for files with "large diffs". Loading the file causes it to say "the file has changed recently" and forces it to refresh, which then causes the changes to no longer be displayed. |
This resolves dotnet/runtime#120508