events: Fixing comments for new method.

This commit is contained in:
Timo 2024-09-12 13:21:22 +02:00 committed by Kévin Commaille
parent 61f5150358
commit 1298c1d690

View File

@ -16,11 +16,11 @@ pub struct CallMemberStateKey {
impl CallMemberStateKey {
/// Constructs a new CallMemberStateKey there are three possible formats:
/// - "_{UserId}_{DeviceId}" example: "_@test:user.org_DEVICE". `device_id`: Some`, `underscore:
/// - `_{UserId}_{DeviceId}` example: `_@test:user.org_DEVICE`. `device_id: Some`, `underscore:
/// true`
/// - "{UserId}_{DeviceId}" example: "@test:user.org_DEVICE". `device_id`: Some`, `underscore:
/// - `{UserId}_{DeviceId}` example: `@test:user.org_DEVICE`. `device_id: Some`, `underscore:
/// false`
/// - "{UserId}" example example: "@test:user.org". `device_id`: None`, underscore is ignored:
/// - `{UserId}` example: `@test:user.org`. `device_id: None`, underscore is ignored:
/// `underscore: false|true`
///
/// Dependent on the parameters the correct CallMemberStateKey will be constructed.