More documentation changes for better module-level documentation rather than file...

[pub/lufa.git] / LUFA / MemoryAllocator / DynAlloc.h

diff --git a/LUFA/MemoryAllocator/DynAlloc.h b/LUFA/MemoryAllocator/DynAlloc.h
index d53b8bb..acbfbd1 100644 (file)
--- 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\r
  *  the standard avr-libc dynamic memory allocation routines. Memory is handed out in block chunks, to reduce the\r
  *  management memory overhead.\r
  *  Dynamic, auto-defragmenting block memory allocator library. This library provides a convenient replacement for\r
  *  the standard avr-libc dynamic memory allocation routines. Memory is handed out in block chunks, to reduce the\r
  *  management memory overhead.\r

+ */\r
+\r
+/** @defgroup Group_MemoryAllocator Dynamic Block Memory Allocator - LUFA/MemoryAllocator/DynAlloc.h\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/MemoryAllocator/DynAlloc.c\r
+ *\r
+ *  \section Module Description\r
+ *  Dynamic, auto-defragmenting block memory allocator library. This library provides a convenient replacement for\r
+ *  the standard avr-libc dynamic memory allocation routines. Memory is handed out in block chunks, to reduce the\r
+ *  management memory overhead.\r

  *\r
  *  Unlike the normal memory allocation routines, this library gives out handles to memory which must be dereferenced\r
  *  at the exact time of use, rather than handing back direct memory pointers. By using library managed handles\r
  *\r
  *  Unlike the normal memory allocation routines, this library gives out handles to memory which must be dereferenced\r
  *  at the exact time of use, rather than handing back direct memory pointers. By using library managed handles\r


@@ -48,12 +60,7 @@
  *  NUM_BLOCKS indicates the number of memory blocks in the memory psudoheap which can be chained together and handed\r
  *  to the application via a memory handle. NUM_HANDLES is the maximum number of memory handles (pointing to one or\r
  *  more chained memory blocks) which can be handed out simultaneously before requiring a handle (and its associated\r
  *  NUM_BLOCKS indicates the number of memory blocks in the memory psudoheap which can be chained together and handed\r
  *  to the application via a memory handle. NUM_HANDLES is the maximum number of memory handles (pointing to one or\r
  *  more chained memory blocks) which can be handed out simultaneously before requiring a handle (and its associated\r

- *  memory) to be freed. BLOCK_SIZE gives the number of bytes in each memory block.\r
- */\r
-\r
-/** @defgroup Group_MemoryAllocator Dynamic Block Memory Allocator - LUFA/MemoryAllocator/DynAlloc.h\r
- *\r
- *  Dynamic auto-degragmenting memory block allocator functions. See DynAlloc.h description for more details.\r
+ *  memory) to be freed. BLOCK_SIZE gives the number of bytes in each memory block. \r

  *\r
  *  @{\r
  */\r
  *\r
  *  @{\r
  */\r