MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2025-01-15 17:16:49 +01:00
Code Issues Releases Wiki Activity

ircd:Ⓜ️:state: Add interface comment after \brief.

Browse source
This commit is contained in:
Jason Volk 2018-04-11 17:18:15 -07:00
parent 1f49f3c193
commit f9ad2523a2
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/ircd/m/state.h
View file

@ -13,6 +13,10 @@
/// Matrix machine state unit and bus.
///
/// !!! note: This is actually a really low-level interface. If you don't
/// know that you are almost certainly looking for the room::state interface
/// and not this.
///
/// This section deals specifically with the aspect of Matrix called "state"
/// providing tools and utilities as well as local databasing. IO is done for
/// reads, and indirect into db::txn's for writes. No network activities are