MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-29 00:44:17 +01:00
Code Issues Releases Wiki Activity

ircd:Ⓜ️:append: Add some \briefs. [skip ci]

Browse source
This commit is contained in:
Jason Volk 2019-09-08 15:23:28 -07:00
parent 529cccbcf0
commit fda4c9d0ce
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
include/ircd/m/event/append.h
View file

@ -11,6 +11,12 @@
#pragma once #pragma once
#define HAVE_IRCD_M_EVENT_APPEND #define HAVE_IRCD_M_EVENT_APPEND
/// Used when transmitting events to clients. This tries to hide and provide
/// as much boilerplate as possible which we abstracted from all of the
/// different locations where an event may be revealed to a client. This device
/// will add things like a client txnid, calculate and add an `unsigned.age`,
/// find and add the prev_state/prev_content for state events, etc.
///
struct ircd::m::event::append struct ircd::m::event::append
:boolean :boolean
{ {
@ -22,6 +28,8 @@ struct ircd::m::event::append
append(json::stack::array &, const event &); append(json::stack::array &, const event &);
}; };
/// Provide as much information as you can apropos this event so the impl
/// can provide the best result.
struct ircd::m::event::append::opts struct ircd::m::event::append::opts
{ {
const event::idx *event_idx {nullptr}; const event::idx *event_idx {nullptr};