0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-09-30 04:38:52 +02:00

ircd:Ⓜ️:event::horizon: Improve some comments.

This commit is contained in:
Jason Volk 2019-08-30 21:31:40 -07:00
parent 10cb380473
commit b38cf0012e

View file

@ -12,14 +12,14 @@
#define HAVE_IRCD_M_EVENT_HORIZON_H #define HAVE_IRCD_M_EVENT_HORIZON_H
/// Interface to the set of unresolved events. This set contains event_id's /// Interface to the set of unresolved events. This set contains event_id's
/// which the server does not have. For each event_id in the set, there is an /// which the server does not have. For each event_id there is an event::idx
/// event::idx of an event which made a reference to the event_id. There may be /// of an event which made a reference to the event_id. There may be multiple
/// multiple entries for an event_id. /// entries for an event_id.
/// ///
/// This information helps construct the dependency graph in event::refs out of /// This information helps construct the dependency graph in event::refs out of
/// order; it is anti-reference which is removed after the event is processed. /// order; it is anti-reference which is removed after the event is processed.
/// Each event::idx for an event_id in the set is then able to be "reprocessed" /// Each event::idx for an event_id in the set is then able to be "reprocessed"
/// in some way; at a minimum the reprocessing removes the event_id|event::idx /// in some way; at a minimum the reprocessing removes this event_id|event::idx
/// entry (see: dbs/event_horizon related). /// entry (see: dbs/event_horizon related).
/// ///
class ircd::m::event::horizon class ircd::m::event::horizon