Skip to content

[Documentation]: Adds missing XML Documentation for PackedVector Namespace Members#8179

Merged
ThomasFOG merged 16 commits intoMonoGame:developfrom
AristurtleDev:documentation/packedvector-namespace
Mar 12, 2024
Merged

[Documentation]: Adds missing XML Documentation for PackedVector Namespace Members#8179
ThomasFOG merged 16 commits intoMonoGame:developfrom
AristurtleDev:documentation/packedvector-namespace

Conversation

@AristurtleDev
Copy link
Copy Markdown
Contributor

Description

This PR adds the missing XML documentation for the following members of the Microsoft.Xna.Framework.Graphics.PackedVector namespace

  • Bgr565
  • Bgra4444
  • Bgra5551
  • HalfSingle
  • HalfVector2
  • IPackedVector
  • Short2
  • Rgba64
  • Rgba1010102
  • Rg32
  • NormalizedShort4
  • NormalizedShort2
  • NormalizedByte4
  • NormalizedByte2

Reference:

Feature Request: Resolve Missing XML For Public Type Warnings

@AristurtleDev
Copy link
Copy Markdown
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.

@AristurtleDev AristurtleDev marked this pull request as draft February 14, 2024 19:49
@AristurtleDev
Copy link
Copy Markdown
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

@AristurtleDev AristurtleDev marked this pull request as ready for review March 4, 2024 06:02
@AristurtleDev
Copy link
Copy Markdown
Contributor Author

Updated based on new contributing guidelines. Ready for review.

@ThomasFOG ThomasFOG merged commit dbc3bfa into MonoGame:develop Mar 12, 2024
@AristurtleDev AristurtleDev deleted the documentation/packedvector-namespace branch March 12, 2024 15:06
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants