Skip to content

Commit

Permalink
Added doc for entity.h
Browse files Browse the repository at this point in the history
  • Loading branch information
ebasconp committed Sep 17, 2024
1 parent 744fb5b commit 885cb20
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion code/classeine-lib/clsn/core/entity.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,18 @@

#include <string_view>

/// 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_
Expand Down

0 comments on commit 885cb20

Please sign in to comment.