diff options
| author | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2012-02-24 20:25:36 +0000 |
|---|---|---|
| committer | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2012-02-24 20:25:36 +0000 |
| commit | b288d2a0911cb9bee87dcfda12450d08cb953470 (patch) | |
| tree | d8ad16a77830f8116e5ae5bdbe99fcb263a7f9d6 /LUFA/Drivers/Misc/RingBuffer.h | |
| parent | 52d58ebd8b36a3943b5f42b88b17fbc13067893d (diff) | |
Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.
git-svn-id: http://lufa-lib.googlecode.com/svn/trunk@2066 d5102386-fcda-11dd-9fdb-3debd5008f28
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 8ed7a914..df7e7021 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. * |