diff options
Diffstat (limited to 'libs')
| -rw-r--r-- | libs/kstd/include/kstd/ext/bitfield_enum | 1 | ||||
| -rw-r--r-- | libs/kstd/kstd.dox | 14 |
2 files changed, 15 insertions, 0 deletions
diff --git a/libs/kstd/include/kstd/ext/bitfield_enum b/libs/kstd/include/kstd/ext/bitfield_enum index 327af45..80fe9d2 100644 --- a/libs/kstd/include/kstd/ext/bitfield_enum +++ b/libs/kstd/include/kstd/ext/bitfield_enum @@ -14,6 +14,7 @@ namespace kstd::ext { }; + //! @concept Specifies that an enum is to be used to define bits in a bitfield. template<typename EnumType> concept bitfield_enum = is_bitfield_enum<EnumType>::value; diff --git a/libs/kstd/kstd.dox b/libs/kstd/kstd.dox new file mode 100644 index 0000000..5920a3c --- /dev/null +++ b/libs/kstd/kstd.dox @@ -0,0 +1,14 @@ +//! @namespace kstd +//! The TeachOS Standard Library. +//! +//! This namespace provides implementation for Standard Library functionality that is not usually provided in a +//! freestanding environment, since it relies on operating system support (e.g. memory allocation). The implementations +//! found here, aim to be reasonably close to the specifications found in the C++ language standard (ISO14482). +//! However, some differences exists, for example the lack of exceptions. + +//! @namespace kstd::ext +//! Extensions to the Standard Library. +//! +//! This namespace includes custom extensions to what is defined for the C++ Standard Library. These extensions not +//! portable per-se, since they are not implemented by other Standard Library implementations. Whenever possible, +//! Standard Library conformant types, functions, etc. should be used throughout the TeachOS codebase. |