mirror of
https://github.com/matrix-construct/construct
synced 2024-10-04 06:38:58 +02:00
ircd:Ⓜ️:state: Add interface comment after \brief.
This commit is contained in:
parent
1f49f3c193
commit
f9ad2523a2
1 changed files with 4 additions and 0 deletions
|
@ -13,6 +13,10 @@
|
||||||
|
|
||||||
/// Matrix machine state unit and bus.
|
/// 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"
|
/// This section deals specifically with the aspect of Matrix called "state"
|
||||||
/// providing tools and utilities as well as local databasing. IO is done for
|
/// 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
|
/// reads, and indirect into db::txn's for writes. No network activities are
|
||||||
|
|
Loading…
Reference in a new issue