From 5fa0e9c00733a13df54dab638fc7bd79231d968e Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Thu, 10 Jun 2010 01:30:32 +0000
Subject: [PATCH] Oops - light weight ring buffer documentation used \ref
instead of \param to document function parameters.
---
Projects/Benito/Lib/LightweightRingBuff.h | 8 ++++----
Projects/USBtoSerial/Lib/LightweightRingBuff.h | 8 ++++----
Projects/XPLAINBridge/Lib/LightweightRingBuff.h | 8 ++++----
3 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/Projects/Benito/Lib/LightweightRingBuff.h b/Projects/Benito/Lib/LightweightRingBuff.h
index 89239ace1..55af753c0 100644
--- a/Projects/Benito/Lib/LightweightRingBuff.h
+++ b/Projects/Benito/Lib/LightweightRingBuff.h
@@ -66,7 +66,7 @@
* before any operations are called upon them. Already initialized buffers may be reset
* by re-initializing them using this function.
*
- * \ref Buffer Pointer to a ring buffer structure to initialize
+ * \param[out] Buffer Pointer to a ring buffer structure to initialize
*/
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
{
@@ -77,8 +77,8 @@
/** Inserts an element into the ring buffer.
*
- * \ref Buffer Pointer to a ring buffer structure to insert into
- * \ref 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
*/
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
{
@@ -95,7 +95,7 @@
/** Retrieves an element from the ring buffer.
*
- * \ref Buffer Pointer to a ring buffer structure to retrieve from
+ * \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
*
* \return Next data element stored in the buffer
*/
diff --git a/Projects/USBtoSerial/Lib/LightweightRingBuff.h b/Projects/USBtoSerial/Lib/LightweightRingBuff.h
index 89239ace1..55af753c0 100644
--- a/Projects/USBtoSerial/Lib/LightweightRingBuff.h
+++ b/Projects/USBtoSerial/Lib/LightweightRingBuff.h
@@ -66,7 +66,7 @@
* before any operations are called upon them. Already initialized buffers may be reset
* by re-initializing them using this function.
*
- * \ref Buffer Pointer to a ring buffer structure to initialize
+ * \param[out] Buffer Pointer to a ring buffer structure to initialize
*/
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
{
@@ -77,8 +77,8 @@
/** Inserts an element into the ring buffer.
*
- * \ref Buffer Pointer to a ring buffer structure to insert into
- * \ref 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
*/
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
{
@@ -95,7 +95,7 @@
/** Retrieves an element from the ring buffer.
*
- * \ref Buffer Pointer to a ring buffer structure to retrieve from
+ * \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
*
* \return Next data element stored in the buffer
*/
diff --git a/Projects/XPLAINBridge/Lib/LightweightRingBuff.h b/Projects/XPLAINBridge/Lib/LightweightRingBuff.h
index 89239ace1..55af753c0 100644
--- a/Projects/XPLAINBridge/Lib/LightweightRingBuff.h
+++ b/Projects/XPLAINBridge/Lib/LightweightRingBuff.h
@@ -66,7 +66,7 @@
* before any operations are called upon them. Already initialized buffers may be reset
* by re-initializing them using this function.
*
- * \ref Buffer Pointer to a ring buffer structure to initialize
+ * \param[out] Buffer Pointer to a ring buffer structure to initialize
*/
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
{
@@ -77,8 +77,8 @@
/** Inserts an element into the ring buffer.
*
- * \ref Buffer Pointer to a ring buffer structure to insert into
- * \ref 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
*/
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
{
@@ -95,7 +95,7 @@
/** Retrieves an element from the ring buffer.
*
- * \ref Buffer Pointer to a ring buffer structure to retrieve from
+ * \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
*
* \return Next data element stored in the buffer
*/
--
GitLab