Skip to content

docs: add missing doc comments and fix copy-paste error in Room.swift - #947

Closed
Sleywill wants to merge 1 commit into
livekit:mainfrom
Sleywill:main
Closed

docs: add missing doc comments and fix copy-paste error in Room.swift#947
Sleywill wants to merge 1 commit into
livekit:mainfrom
Sleywill:main

Conversation

@Sleywill

Copy link
Copy Markdown

Summary

Two types of fix in Room.swift:

1. Copy-paste error (bug)

serverNodeId had the same doc comment as serverRegion:

// Before (wrong — copy-pasted from serverRegion)
/// Region code the client is currently connected to.
public var serverNodeId: String? { _state.serverInfo?.nodeID.nilIfEmpty }

// After (correct)
/// The ID of the server node the client is currently connected to.
public var serverNodeId: String? { _state.serverInfo?.nodeID.nilIfEmpty }

2. Missing doc comments

Added /// documentation to 10 public properties that had none:

name, serverVersion, remoteParticipants, activeSpeakers, creationTime, maxParticipants, participantCount, publishersCount, token, disconnectError

No behaviour changes.

- 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`.
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@pblazej

pblazej commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

@Sleywill could you sign the cla?

@pblazej
pblazej self-requested a review March 17, 2026 10:40
@pblazej pblazej closed this Apr 1, 2026
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.

3 participants