Browse Source

Update documentation of core/mem

Daniele Bartolini 12 năm trước cách đây
mục cha
commit
9d630d8fff

+ 2 - 0
engine/core/mem/Allocator.h

@@ -35,6 +35,8 @@ namespace crown
 {
 
 /// Base class for memory allocators.
+///
+/// @ingroup Memory
 class Allocator
 {
 public:

+ 2 - 0
engine/core/mem/LinearAllocator.h

@@ -33,6 +33,8 @@ namespace crown
 
 /// Allocates memory linearly from a predefined chunk
 /// and frees all the allocations with a single call to clear()
+///
+/// @ingroup Memory
 class LinearAllocator : public Allocator
 {
 public:

+ 2 - 0
engine/core/mem/Memory.h

@@ -31,6 +31,8 @@ OTHER DEALINGS IN THE SOFTWARE.
 
 namespace crown
 {
+
+/// @defgroup Memory Memory
 namespace memory
 {
 

+ 2 - 0
engine/core/mem/PoolAllocator.h

@@ -35,6 +35,8 @@ namespace crown
 
 /// Allocates fixed-size memory blocks from a fixed memory pool.
 /// The backing allocator is used to allocate the memory pool.
+///
+/// @ingroup Memory
 class PoolAllocator : public Allocator
 {
 public:

+ 2 - 0
engine/core/mem/ProxyAllocator.h

@@ -37,6 +37,8 @@ namespace crown
 /// Offers the facility to tag allocators by a string identifier.
 /// Proxy allocator is appended to a global linked list when instantiated
 /// so that it is possible to later visit that list for debugging purposes.
+///
+/// @ingroup Memory
 class CE_EXPORT ProxyAllocator : public Allocator
 {
 public:

+ 2 - 0
engine/core/mem/StackAllocator.h

@@ -34,6 +34,8 @@ namespace crown
 /// Allocates memory linearly in a stack-like fashion from a
 /// predefined chunk. All deallocations must occur in LIFO
 /// order.
+///
+/// @ingroup Memory
 class StackAllocator : public Allocator
 {
 public:

+ 2 - 0
engine/core/mem/TempAllocator.h

@@ -35,6 +35,8 @@ namespace crown
 /// When the internal memory is exhausted or the allocation size exceeds
 /// the remainig internal storage, the backing allocator is used instead.
 /// The memory is automatically freed when the allocator is destroyed.
+///
+/// @ingroup Memory
 template <size_t SIZE>
 class TempAllocator : public Allocator
 {