Minor documentation adjustments to the demos, projects and bootloaders to ensure...

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

diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h
index cd9ced2..df7e702 100644 (file)
--- a/LUFA/Drivers/Misc/RingBuffer.h
+++ b/LUFA/Drivers/Misc/RingBuffer.h
@@ -7,7 +7,7 @@
 */
 
 /*
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -225,9 +225,9 @@
 
                /** Inserts an element into the ring buffer.
                 *
 
                /** Inserts an element into the ring buffer.
                 *

-                *  \note Only one execution thread (main program thread or an ISR) may insert into a single buffer
-                *        otherwise data corruption may occur. Insertion and removal may occur from different execution
-                *        threads.
+                *  \warning Only one execution thread (main program thread or an ISR) may insert into a single buffer
+                *           otherwise data corruption may occur. Insertion and removal may occur from different execution
+                *           threads.

                 *
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.
                 *  \param[in]     Data    Data element to insert into the buffer.
                 *
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.
                 *  \param[in]     Data    Data element to insert into the buffer.


@@ -252,9 +252,9 @@
 
                /** Removes an element from the ring buffer.
                 *
 
                /** Removes an element from the ring buffer.
                 *

-                *  \note Only one execution thread (main program thread or an ISR) may remove from a single buffer
-                *        otherwise data corruption may occur. Insertion and removal may occur from different execution
-                *        threads.
+                *  \warning Only one execution thread (main program thread or an ISR) may remove from a single buffer
+                *           otherwise data corruption may occur. Insertion and removal may occur from different execution
+                *           threads.

                 *
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to retrieve from.
                 *
                 *
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to retrieve from.
                 *