X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/6a10d6b465be27db090d760dc0fbe722c94e4344..526e398986583e2fb65c0a36a2fbf2ce153446e5:/LUFA/MemoryAllocator/DynAlloc.h

diff --git a/LUFA/MemoryAllocator/DynAlloc.h b/LUFA/MemoryAllocator/DynAlloc.h
index 6fd743ea3..acbfbd18a 100644
--- a/LUFA/MemoryAllocator/DynAlloc.h
+++ b/LUFA/MemoryAllocator/DynAlloc.h
@@ -33,6 +33,18 @@
  *  Dynamic, auto-defragmenting block memory allocator library. This library provides a convenient replacement for
  *  the standard avr-libc dynamic memory allocation routines. Memory is handed out in block chunks, to reduce the
  *  management memory overhead.
+ */
+
+/** @defgroup Group_MemoryAllocator Dynamic Block Memory Allocator - LUFA/MemoryAllocator/DynAlloc.h
+ *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/MemoryAllocator/DynAlloc.c
+ *
+ *  \section Module Description
+ *  Dynamic, auto-defragmenting block memory allocator library. This library provides a convenient replacement for
+ *  the standard avr-libc dynamic memory allocation routines. Memory is handed out in block chunks, to reduce the
+ *  management memory overhead.
  *
  *  Unlike the normal memory allocation routines, this library gives out handles to memory which must be dereferenced
  *  at the exact time of use, rather than handing back direct memory pointers. By using library managed handles
@@ -45,10 +57,12 @@
  *  The constants NUM_BLOCKS, BLOCK_SIZE and NUM_HANDLES must be defined in the project makefile (and passed to the
  *  preprocessor via the -D GCC switch) for this library to compile.
  *
- *  NUM_BLOCKS indicates the number of memory blocks in the memory psudoheap which can be chaned together and handed
+ *  NUM_BLOCKS indicates the number of memory blocks in the memory psudoheap which can be chained together and handed
  *  to the application via a memory handle. NUM_HANDLES is the maximum number of memory handles (pointing to one or
- *  more chained memory blocks) which can be handed out simultaneously before requring a handle (and its associated
- *  memory) to be freed. BLOCK_SIZE gives the number of bytes in each memory block.
+ *  more chained memory blocks) which can be handed out simultaneously before requiring a handle (and its associated
+ *  memory) to be freed. BLOCK_SIZE gives the number of bytes in each memory block. 
+ *
+ *  @{
  */
 
 #ifndef __DYN_ALLOC__
@@ -67,7 +81,7 @@
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */
 			/** Macro to dereference a given memory handle into the given type. The given type should be a pointer
-			 *  if the memory is to contain an array of items, or should be a standard type (such as a primative or
+			 *  if the memory is to contain an array of items, or should be a standard type (such as a primitive or
 			 *  structure) if the memory is to hold a single item of a single type. */
 			#define DEREF(handle, type)       (*(type*)handle)
 			
@@ -180,3 +194,5 @@
 	#endif
 	
 #endif
+
+/** @} */