chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

events: Fix documentation for a few functions

Browse Source
This commit is contained in:
Jonas Platte 2023-06-13 17:25:11 +02:00
parent b183677ef5
commit beded100ac
No known key found for this signature in database
GPG Key ID: AAA7A61F696C3E0C
4 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
crates/ruma-common/src/events/file.rs
View File

@ -70,7 +70,7 @@ impl FileEventContent {
} }
/// Creates a new non-encrypted `FileEventContent` with the given plain text fallback /// Creates a new non-encrypted `FileEventContent` with the given plain text fallback
/// representation, url and file info. /// representation, url and name.
pub fn plain_with_plain_text( pub fn plain_with_plain_text(
plain_text: impl Into<String>, plain_text: impl Into<String>,
url: OwnedMxcUri, url: OwnedMxcUri,
@ -87,7 +87,7 @@ impl FileEventContent {
} }
/// Creates a new encrypted `FileEventContent` with the given fallback representation, url, /// Creates a new encrypted `FileEventContent` with the given fallback representation, url,
/// encryption info and file info. /// name and encryption info.
pub fn encrypted( pub fn encrypted(
text: TextContentBlock, text: TextContentBlock,
url: OwnedMxcUri, url: OwnedMxcUri,
@ -105,7 +105,7 @@ impl FileEventContent {
} }
/// Creates a new encrypted `FileEventContent` with the given plain text fallback /// Creates a new encrypted `FileEventContent` with the given plain text fallback
/// representation, url, encryption info and file info. /// representation, url, name and encryption info.
pub fn encrypted_with_plain_text( pub fn encrypted_with_plain_text(
plain_text: impl Into<String>, plain_text: impl Into<String>,
url: OwnedMxcUri, url: OwnedMxcUri,

3
crates/ruma-common/src/events/room/message/audio.rs
View File

@ -31,8 +31,7 @@ impl AudioMessageEventContent {
Self { body, source, info: None } Self { body, source, info: None }
} }
/// Creates a new non-encrypted `AudioMessageEventContent` with the given body, url and /// Creates a new non-encrypted `AudioMessageEventContent` with the given bod and url.
/// optional extra info.
pub fn plain(body: String, url: OwnedMxcUri) -> Self { pub fn plain(body: String, url: OwnedMxcUri) -> Self {
Self::new(body, MediaSource::Plain(url)) Self::new(body, MediaSource::Plain(url))
} }

3
crates/ruma-common/src/events/room/message/file.rs
View File

@ -35,8 +35,7 @@ impl FileMessageEventContent {
Self { body, filename: None, source, info: None } Self { body, filename: None, source, info: None }
} }
/// Creates a new non-encrypted `FileMessageEventContent` with the given body, url and /// Creates a new non-encrypted `FileMessageEventContent` with the given body and url.
/// optional extra info.
pub fn plain(body: String, url: OwnedMxcUri) -> Self { pub fn plain(body: String, url: OwnedMxcUri) -> Self {
Self::new(body, MediaSource::Plain(url)) Self::new(body, MediaSource::Plain(url))
} }

3
crates/ruma-common/src/events/room/message/video.rs
View File

@ -32,8 +32,7 @@ impl VideoMessageEventContent {
Self { body, source, info: None } Self { body, source, info: None }
} }
/// Creates a new non-encrypted `VideoMessageEventContent` with the given body, url and /// Creates a new non-encrypted `VideoMessageEventContent` with the given body and url.
/// optional extra info.
pub fn plain(body: String, url: OwnedMxcUri) -> Self { pub fn plain(body: String, url: OwnedMxcUri) -> Self {
Self::new(body, MediaSource::Plain(url)) Self::new(body, MediaSource::Plain(url))
} }