Skip to content

Commit bb6eaf7

Browse files
Cleanup comments
1 parent 0c51eac commit bb6eaf7

1 file changed

Lines changed: 0 additions & 31 deletions

File tree

include/livekit/local_participant.h

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -108,24 +108,6 @@ class LIVEKIT_API LocalParticipant : public Participant {
108108
*/
109109
void publishDtmf(int code, const std::string& digit);
110110

111-
// -------------------------------------------------------------------------
112-
// Metadata APIs (set metadata / name / attributes)
113-
//
114-
// These methods send an FFI request to the LiveKit server and are the
115-
// canonical way for an SDK consumer to update the local participant's
116-
// server-visible state. They match the naming used by the Python and other
117-
// LiveKit SDKs (e.g. `LocalParticipant.set_name`).
118-
//
119-
// They intentionally shadow the deprecated in-memory cache mutators on the
120-
// base \c Participant class. The shadowing is suppressed via NOLINT because
121-
// it is the desired behavior: callers using a \c LocalParticipant pointer
122-
// get the server-syncing implementation, while the deprecated base mutators
123-
// remain only for source-compat with the (internal) call sites that have
124-
// not yet migrated.
125-
// -------------------------------------------------------------------------
126-
127-
// NOLINTBEGIN(bugprone-derived-method-shadowing-base-method)
128-
129111
/**
130112
* Update this participant's metadata on the server.
131113
*
@@ -159,19 +141,6 @@ class LIVEKIT_API LocalParticipant : public Participant {
159141
*/
160142
void setAttributes(const std::unordered_map<std::string, std::string>& attributes);
161143

162-
// NOLINTEND(bugprone-derived-method-shadowing-base-method)
163-
164-
// -------------------------------------------------------------------------
165-
// Deprecated transitional aliases.
166-
//
167-
// The update* names were briefly introduced (commit c271f9d) as a
168-
// workaround for the shadowing produced by the previous round of
169-
// deprecation work. They are retained as forwarders so anyone who pulled
170-
// from main during that window gets a clear migration warning rather than
171-
// a hard build break. Prefer the canonical setName / setMetadata /
172-
// setAttributes above, which match the Python and other LiveKit SDKs.
173-
// -------------------------------------------------------------------------
174-
175144
[[deprecated("LocalParticipant::updateMetadata is deprecated; use LocalParticipant::setMetadata instead")]]
176145
void updateMetadata(const std::string& metadata) {
177146
setMetadata(metadata);

0 commit comments

Comments
 (0)