X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d1261468875f4772898c4395880735784e651d91..039a714ee46268c07928c79b30403f29d4040fe8:/LUFA/Drivers/Misc/RingBuffer.h diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h index 605f92c11..37e8a1ba5 100644 --- a/LUFA/Drivers/Misc/RingBuffer.h +++ b/LUFA/Drivers/Misc/RingBuffer.h @@ -35,9 +35,9 @@ * different sizes to suit different needs. * * Note that for each buffer, insertion and removal operations may occur at the same time (via - * a multithreaded ISR based system) however the same kind of operation (two or more insertions + * a multi-threaded ISR based system) however the same kind of operation (two or more insertions * or deletions) must not overlap. If there is possibility of two or more of the same kind of - * operating occuring at the same point in time, atomic (mutex) locking should be used. + * operating occurring at the same point in time, atomic (mutex) locking should be used. */ /** \ingroup Group_MiscDrivers @@ -52,9 +52,9 @@ * different sizes to suit different needs. * * Note that for each buffer, insertion and removal operations may occur at the same time (via - * a multithreaded ISR based system) however the same kind of operation (two or more insertions + * a multi-threaded ISR based system) however the same kind of operation (two or more insertions * or deletions) must not overlap. If there is possibility of two or more of the same kind of - * operating occuring at the same point in time, atomic (mutex) locking should be used. + * operating occurring at the same point in time, atomic (mutex) locking should be used. * * \section Sec_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical @@ -170,7 +170,7 @@ * * \param[in,out] Buffer Pointer to a ring buffer structure to insert into. * - * \return Boolean true if the buffer contains no free space, false otherwise. + * \return Boolean \c true if the buffer contains no free space, false otherwise. */ static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) { @@ -187,7 +187,7 @@ * * \param[in,out] Buffer Pointer to a ring buffer structure to insert into. * - * \return Boolean true if the buffer contains no free space, false otherwise. + * \return Boolean \c true if the buffer contains no free space, false otherwise. */ static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) {