docs: fixes of PVP-150-1 [2.X]#3223
Merged
NoelStephensUnity merged 22 commits intodevelop-2.0.0from Feb 14, 2025
Merged
Conversation
NoelStephensUnity
approved these changes
Feb 5, 2025
Member
NoelStephensUnity
left a comment
There was a problem hiding this comment.
I think we are still missing some XML documentation, but this is a very good start!
🥇
Member
Author
|
I did it based on PVP exceptions I saw in the file, it may happen that some new places were introduced since I created this branch. That's why I would like to merge CI changes (LINK) first since this will detect (and block) any new "introduction of related errors" so we can make sure we are addressing all XmlDoc issues (this is different from API docs and there will be a separate PR for those (LINK), it's still work in progress though, I may have it next week) |
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.
This PR focuses on fixing errors related to PVP-150-1 "XmlDoc should be valid"
At the beginning I wanted to fix both PVP-150-1 as well as PVP-151-1 in one PR but I came to the conclusion that it's better to separate those because of the amount of changes to be checked for correctness.
There were several places (like for example FastBufferWriter/FastBufferReader) where XmlDoc was describing unused parameter
<param name="unused">An unused parameter used for enabling overload resolution based on generic constraints</param>, we should ensure that it's correct that said argument is not used by the given APIs.Additionally pvpException file was moved out of the package and package-pack and package-test were corrected with proper usage of upm-pvp and proper exceptions checking