diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2012-02-24 20:25:36 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2012-02-24 20:25:36 +0000 |
| commit | e406140f119281a945c281d25e9a1041b862d592 (patch) | |
| tree | d8ad16a77830f8116e5ae5bdbe99fcb263a7f9d6 /LUFA/Drivers/Misc/RingBuffer.h | |
| parent | 5561524a8fe7baaeaac3421c9e1d3347186fdf95 (diff) | |
| download | lufa-e406140f119281a945c281d25e9a1041b862d592.tar.gz lufa-e406140f119281a945c281d25e9a1041b862d592.tar.bz2 lufa-e406140f119281a945c281d25e9a1041b862d592.zip | |
Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.
Diffstat (limited to 'LUFA/Drivers/Misc/RingBuffer.h')
| -rw-r--r-- | LUFA/Drivers/Misc/RingBuffer.h | 12 |
1 files changed, 6 insertions, 6 deletions
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. * |