fix: API Audit for missing XML documentation [MTT-3881]#2026
Merged
fix: API Audit for missing XML documentation [MTT-3881]#2026
Conversation
Fixing load and unload XML Documentation issue.
Adding XML Documentation to NetworkManager's ShutdownInProgress property
Adding XML Documentation for NetworkManager's SceneManager property.
Adding XML Documentation to the PrefabHandler property.
Fixed the missing return type XML Documentation issue.
Fixing missing xml documentation for the missing parameter "parentNetworkObject" and adding xml documentation header to OnDestroy.
Adding the XML Documentation for the return value
Adding missing XML documentation to the CheckForNetworkObject method.
This update adds xml documentation to each enum value of NetworkUpdateState
This fix adds the missing XML Documentation parameters
Added return value xml documentation for GetClientOwnedObjects Added parameter xml documentation for GetPlayerNetworkObject
Adding the missing xml documentation.
Added the missing xml documentation headers
Fixed missing xml documentation issues for: RotAngleThresholdDefault ScaleThresholdDefault PositionThreshold RotAngleThreshold ScaleThreshold Interpolate OnIsServerAuthoritatitive()
Adding xml documentation for: InitialMaxPacketQueueSize InitialMaxPayloadSize InitialMaxSendQueueSize s_DriverConstructor DriverConstructor ConnectionData DebugSimulator
…FastBufferReader, FastBufferWriter, ForceNetworkSerializeByMemcpy, INetworkSerializeByMemcpy, IReaderWriter, InvalidChannelException
…y-Technologies/com.unity.multiplayer.mlapi into audit/api-missing-xml-documentation
Contributor
|
All flagged docs APIs have been fixed. Only TestHelper stuff remains which is not critical for 1.0 |
ashwinimurt
approved these changes
Jun 27, 2022
| /// Note: | ||
| /// When this method returns false it could mean: | ||
| /// - You are trying to start a client that is already started | ||
| /// - It failed during the initial port binding when attempting to begin to connect |
Contributor
There was a problem hiding this comment.
Can drop the "when attempting to connect" since this is not a client.
simon-lemay-unity
approved these changes
Jun 27, 2022
Contributor
simon-lemay-unity
left a comment
There was a problem hiding this comment.
Only reviewed transport changes, but looks good to me!
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
7 participants
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 includes all of the missing XML Documentation as outlined in the spreadsheet.
MTT-3881
Testing and Documentation