[Documentation]: Adds missing XML Documentation for PackedVector Namespace Members#8179
Merged
ThomasFOG merged 16 commits intoMonoGame:developfrom Mar 12, 2024
Conversation
Contributor
Author
|
I added all members from the same namespace in this single PR instead of a separate PR for each member. If you would prefer a separate PR for each member, I can close and redo the PR for each one. |
Contributor
Author
|
Switching to draft PR so reviews and feedback can be made, but waiting for guidelines to be updated for documentation before checking for merge |
Contributor
Author
|
Updated based on new contributing guidelines. Ready for review. |
viniciusjarina
pushed a commit
to codefoco/MonoGame
that referenced
this pull request
Mar 16, 2024
…space Members (MonoGame#8179) * Add missing XML documentation for Bgr565 * Add missing XML documentation for Bgra4444 * Add missing XML documentation for Bgra5551 * Add missing XML documentation for HalfSingle * Add missing XML documentation for HalfVector2 * Add missing XML documentation for IPackedVector * Add missing XML documentation for Short2 * Add missing XML documentation for Rgba64 * Add missing XML documentation for Rgba1010102 * Add missing XML documentation for Rg32 * Add missing XML documentation for NormalizedShort4 * Add missing XML documentation for NormalizedShort2 * Add missing XML documentation for NormalizedByte4 * Add missing XML documentation for NormalizedByte2 * Ensure XML documentation is consistant across all PackedVector members (#1) * Update based on new contributing guidelines
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the missing XML documentation for the following members of the
Microsoft.Xna.Framework.Graphics.PackedVectornamespaceBgr565Bgra4444Bgra5551HalfSingleHalfVector2IPackedVectorShort2Rgba64Rgba1010102Rg32NormalizedShort4NormalizedShort2NormalizedByte4NormalizedByte2Reference:
Feature Request: Resolve Missing XML For Public Type Warnings