MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-27 07:54:05 +01:00
Code Issues Releases Wiki Activity

ircd: Minor comment cleanup.

Browse source
This commit is contained in:
Jason Volk 2018-01-25 12:14:48 -08:00
parent 1cdb893b1b
commit 610d4ad9da
3 changed files with 12 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
include/ircd/allocator.h
View file

@ -32,25 +32,6 @@
/// templates implement the std::allocator concept and can be used with
/// std:: containers by specifying them in the container's template parameter.
///
/// The ircd::allocator::fixed is the prototypical justification for these
/// tools. It allows you to build a memory pool with a size known at compile-
/// time at the place of your choosing (i.e the stack) for any STL container. A
/// simple std::vector constructed on the stack with a fixed number of elements
/// known at construction time won't otherwise magically optimize away the
/// allocation for the elements; worse, a non-contiguous container like
/// std::list, std::map or std::set will conduct allocations for each modifying
/// operation. Having the fixed pool on the stack plugged into these containers
/// trivializes those requests and releases of memory.
///
/// The ircd::allocator::dynamic performs a single allocation of a contiguous
/// memory block with a size specified at runtime. This block can then be used
/// by a container.
///
/// The ircd::allocator::node is an interface for allowing one to manually deal
/// with the elements of an STL container similar to a C style container where
/// a "node" is constructed at the user's discretion and then inserted and
/// removed from the container.
///
namespace ircd::allocator
{
struct state;

8
include/ircd/db/database/column.h
View file

@ -11,6 +11,10 @@
#pragma once
#define HAVE_IRCD_DB_DATABASE_COLUMN_H
// This file is not part of the standard include stack because it requires
// RocksDB symbols which we cannot forward declare. It is used internally
// and does not need to be included by general users of IRCd.
/// Internal column interface panel. This is db::database::column, not
/// db::column. The latter is a public shared-pointer front-end which
/// points to an internally managed database::column.
@ -24,10 +28,6 @@ namespace ircd::db
void drop(database::column &); // Request to erase column from db
}
// This file is not part of the standard include stack because it requires
// RocksDB symbols which we cannot forward declare. It is used internally
// and does not need to be included by general users of IRCd.
struct ircd::db::database::column final
:std::enable_shared_from_this<database::column>
,rocksdb::ColumnFamilyDescriptor

10
include/ircd/m/event.h
View file

@ -49,8 +49,14 @@ namespace ircd::m
/// This json::tuple provides at least all of the legal members of the matrix
/// standard event. This is the fundamental building block of the matrix
/// system. Rooms are collections of events. Messages between servers are
/// passed as bundles of events (or directly). Due to the ubiquitous usage,
/// and diversity of extensions, the class member interface is somewhat minimal.
/// passed as bundles of events (or directly).
///
/// Due to the ubiquitous usage, and diversity of extensions, the class
/// member interface is somewhat minimal.
///
/// It is better to have 100 functions operate on one data structure than
/// to have 10 functions operate on 10 data structures.
/// -Alan Perlis
///
struct ircd::m::event
:json::tuple