docs: add missing doc comments and fix copy-paste error in Room.swift - #947
Closed
Sleywill wants to merge 1 commit into
Closed
docs: add missing doc comments and fix copy-paste error in Room.swift#947Sleywill wants to merge 1 commit into
Sleywill wants to merge 1 commit into
Conversation
- Fix: `serverNodeId` had the same doc comment as `serverRegion`
("Region code") — corrected to describe the server node ID.
- Add: doc comments to 10 undocumented public properties:
`name`, `serverVersion`, `remoteParticipants`, `activeSpeakers`,
`creationTime`, `maxParticipants`, `participantCount`,
`publishersCount`, `token`, `disconnectError`.
|
|
Contributor
|
@Sleywill could you sign the cla? |
pblazej
self-requested a review
March 17, 2026 10:40
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.
Summary
Two types of fix in
Room.swift:1. Copy-paste error (bug)
serverNodeIdhad the same doc comment asserverRegion:2. Missing doc comments
Added
///documentation to 10 public properties that had none:name,serverVersion,remoteParticipants,activeSpeakers,creationTime,maxParticipants,participantCount,publishersCount,token,disconnectErrorNo behaviour changes.