aboutsummaryrefslogtreecommitdiff
path: root/libs/kstd/kstd.dox
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@ost.ch>2025-12-15 17:13:12 +0100
committerFelix Morgner <felix.morgner@ost.ch>2025-12-15 17:13:12 +0100
commit7b9482ae637126ac9337876e60f519b493437711 (patch)
tree6fc71a253c8b0325d303bd34c95b564ba536ed14 /libs/kstd/kstd.dox
parent116f9332a206767c45095950f09f7c7447b561cf (diff)
parenta9eeec745e29d89afd48ee43d09432eb6fc35be7 (diff)
downloadteachos-7b9482ae637126ac9337876e60f519b493437711.tar.xz
teachos-7b9482ae637126ac9337876e60f519b493437711.zip
os: rework kernel architecture
Rework the code structure and architecture of the kernel by separating platform-dependent and platform-independent code more cleanly. As of this patchset, full feature parity has not been achieved. Nonetheless, a sufficient subset of functionality has been ported to the new architecture to demonstrate the feasibility of the new structure.
Diffstat (limited to 'libs/kstd/kstd.dox')
-rw-r--r--libs/kstd/kstd.dox14
1 files changed, 14 insertions, 0 deletions
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.