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

federation-api: Rewrap doc comments

Browse Source
This commit is contained in:
Jonas Platte 2020-09-17 22:00:22 +02:00
parent 133056c524
commit 2b01a8211a
No known key found for this signature in database
GPG Key ID: CC154DE0E30B7C67
3 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
ruma-federation-api/src/membership/create_leave_event/v1.rs
View File

@ -105,8 +105,7 @@ impl<'a> Request<'a> {
} }
impl Response { impl Response {
/// Creates a new `Response` with an empty event, /// Creates a new `Response` with an empty event, to indicate the event was accepted into the
/// to indicate the event was accepted into the
/// graph by the receiving homeserver. /// graph by the receiving homeserver.
pub fn new(event: Empty) -> Self { pub fn new(event: Empty) -> Self {
Self { event } Self { event }

3
ruma-federation-api/src/membership/create_leave_event/v2.rs
View File

@ -104,8 +104,7 @@ impl<'a> Request<'a> {
} }
impl Response { impl Response {
/// Creates a new `Response` with an empty event, /// Creates a new `Response` with an empty event, to indicate the event was accepted into the
/// to indicate the event was accepted into the
/// graph by the receiving homeserver. /// graph by the receiving homeserver.
pub fn new(event: Empty) -> Self { pub fn new(event: Empty) -> Self {
Self { event } Self { event }

9
ruma-federation-api/src/membership/get_leave_event/v1.rs
View File

@ -29,15 +29,18 @@ ruma_api! {
} }
response: { response: {
/// The version of the room where the server is trying to leave. If not provided, the room version is assumed to be either "1" or "2". /// The version of the room where the server is trying to leave. If not provided, the room
/// version is assumed to be either "1" or "2".
pub room_version: Option<RoomVersionId>, pub room_version: Option<RoomVersionId>,
/// An unsigned template event. Note that events have a different format depending on the room version - check the room version specification for precise event formats. /// An unsigned template event. Note that events have a different format depending on the
/// room version - check the room version specification for precise event formats.
pub event: EventTemplate, pub event: EventTemplate,
} }
} }
/// An unsigned template event. Note that events have a different format depending on the room version - check the room version specification for precise event formats. /// An unsigned template event. Note that events have a different format depending on the room
/// version - check the room version specification for precise event formats.
#[derive(Clone, Debug, Serialize, Deserialize)] #[derive(Clone, Debug, Serialize, Deserialize)]
pub struct EventTemplate { pub struct EventTemplate {
/// The user ID of the leaving member. /// The user ID of the leaving member.