Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-05-07 08:56:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

tweak documentation towards https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text - thanks @flub

Browse Source
This commit is contained in:
B. Petersen
2020-10-09 00:28:44 +02:00
parent da727740ab
commit 4eb8d3fef6
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/chat.rs
View File

@@ -174,7 +174,8 @@ impl ChatId {
self.set_blocked(context, Blocked::Not).await; self.set_blocked(context, Blocked::Not).await;
} }
/// Set protection without sending a message. /// Sets protection without sending a message.
///
/// Used when a message arrives indicating that someone else has /// Used when a message arrives indicating that someone else has
/// changed the protection value for a chat. /// changed the protection value for a chat.
pub(crate) async fn inner_set_protection( pub(crate) async fn inner_set_protection(
@@ -226,7 +227,7 @@ impl ChatId {
Ok(()) Ok(())
} }
/// returns a stock message saying that protection status has changed. /// Returns a stock message saying that protection status has changed.
pub(crate) async fn get_protection_msg( pub(crate) async fn get_protection_msg(
self, self,
context: &Context, context: &Context,
@@ -246,7 +247,7 @@ impl ChatId {
.await .await
} }
/// adds or sends out a protection-info-message /// Adds or sends out a protection-info-message.
pub(crate) async fn add_protection_msg( pub(crate) async fn add_protection_msg(
self, self,
context: &Context, context: &Context,
@@ -272,7 +273,7 @@ impl ChatId {
Ok(()) Ok(())
} }
/// Set protection and sends or adds a message. /// Sets protection and sends or adds a message.
pub async fn set_protection( pub async fn set_protection(
self, self,
context: &Context, context: &Context,