Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / LUFA / Drivers / Misc / RingBuffer.h

diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h
index af6a69f..3af5d8e 100644 (file)
--- a/LUFA/Drivers/Misc/RingBuffer.h
+++ b/LUFA/Drivers/Misc/RingBuffer.h
@@ -47,7 +47,7 @@
  *  The following files must be built with any user project that uses this module:\r
  *    - None\r
  *\r
  *  The following files must be built with any user project that uses this module:\r
  *    - None\r
  *\r

- *  \section Module Description\r
+ *  \section Sec_ModDescription Module Description\r

  *  Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of\r
  *  different sizes to suit different needs.\r
  *\r
  *  Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of\r
  *  different sizes to suit different needs.\r
  *\r


@@ -56,7 +56,10 @@
  *  or deletions) must not overlap. If there is possibility of two or more of the same kind of\r
  *  operating occuring at the same point in time, atomic (mutex) locking should be used.\r
  *\r
  *  or deletions) must not overlap. If there is possibility of two or more of the same kind of\r
  *  operating occuring at the same point in time, atomic (mutex) locking should be used.\r
  *\r

- *  <b>Example Usage:</b>\r
+ *  \section Sec_ExampleUsage Example Usage\r
+ *  The following snippet is an example of how this module may be used within a typical\r
+ *  application.\r
+ *\r

  *  \code\r
  *      // Create the buffer structure and its underlying storage array\r
  *      RingBuff_t Buffer;\r
  *  \code\r
  *      // Create the buffer structure and its underlying storage array\r
  *      RingBuff_t Buffer;\r