From 885cb20fb63302ed507c3995187b325ed50aed6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ernesto=20Alfonso=20Basc=C3=B3n=20Pantoja?= Date: Tue, 17 Sep 2024 21:45:03 +0200 Subject: [PATCH] Added doc for entity.h --- code/classeine-lib/clsn/core/entity.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/code/classeine-lib/clsn/core/entity.h b/code/classeine-lib/clsn/core/entity.h index 22d5b208d..3ce5ae971 100644 --- a/code/classeine-lib/clsn/core/entity.h +++ b/code/classeine-lib/clsn/core/entity.h @@ -14,9 +14,18 @@ #include +/// This namespace contains several basic utilities and base classes that +/// make developing applications with *classeine* easier. +/// +/// Configuration utilities, console methods, events, properties, and string +/// handling utilities are available here. namespace clsn::core { - // Base class for polymorphic containers + /// This is the base class for all polymorphic class hierarchies. + /// + /// In addition to providing a base for polymorphic use within containers, + /// it exposes a `to_string()` method and, in debug mode, stores information + /// about objects being instantiated and deallocated. class entity { #ifdef _CLSN_DEBUG_