From e406140f119281a945c281d25e9a1041b862d592 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Fri, 24 Feb 2012 20:25:36 +0000 Subject: Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation. --- LUFA/Drivers/Misc/RingBuffer.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'LUFA/Drivers/Misc') diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h index 8ed7a9144..df7e70218 100644 --- a/LUFA/Drivers/Misc/RingBuffer.h +++ b/LUFA/Drivers/Misc/RingBuffer.h @@ -225,9 +225,9 @@ /** 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. @@ -252,9 +252,9 @@ /** 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. * -- cgit v1.2.3