Added documentation for CcuAllocatorOf

1 files changed, 27 insertions, 0 deletions

diff --git a/utils/Allocator.cc b/utils/Allocator.cc
index d89ebf6..d1bdf8d 100644
--- a/utils/Allocator.cc
+++ b/utils/Allocator.cc
@@ -145,3 +145,30 @@ CcuAllocator :: Free (void* p)
 	FreeList = p;
 #endif
 }
+
+
+#ifdef DOC
+
+/*?class CcuAllocatorOf
+The template class \typ{CcuAllocatorOf <OBJECT>} is a generic version of the class
+\typ{CcuAllocator} that is designed to allocate memory for objects of the class \typ{OBJECT}.
+The following functions are redefined:
+?*/
+
+/*?
+Build an allocator that will allow blocks with the same size as objects of class \typ{OBJECT}.
+?*/
+CcuAllocatorOf :: CcuAllocatorOf ()
+{
+}
+
+/*?
+This function is the same as \typ{CcuAllocator}::\fun{Alloc} except that it returns \typ{OBJECT*}
+instead of \typ{void*}.
+?*/
+OBJECT*
+CcuAllocatorOf :: Alloc ()
+{
+}
+
+#endif	/* DOC */