git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@619 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 25 insertions, 25 deletions

diff --git a/src/chqueues.c b/src/chqueues.c
index 30e71a055..f7cc10f42 100644
--- a/src/chqueues.c
+++ b/src/chqueues.c
@@ -29,11 +29,11 @@
 /**

  * Initializes an input queue. A Semaphore is internally initialized

  * and works as a counter of the bytes contained in the queue.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  * @param buffer pointer to a memory area allocated as queue buffer

  * @param size size of the queue buffer

  * @param inotify pointer to a callback function that is invoked when

- *        some data is read from the Queue. The value can be \p NULL.

+ *        some data is read from the Queue. The value can be @p NULL.

  */

 void chIQInit(Queue *qp, uint8_t *buffer, size_t size, qnotify_t inotify) {

 

@@ -46,7 +46,7 @@ void chIQInit(Queue *qp, uint8_t *buffer, size_t size, qnotify_t inotify) {
 /**

  * Resets an input queue. All the data is lost and the waiting threads

  * resumed.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  */

 void chIQReset(Queue *qp) {

 

@@ -60,7 +60,7 @@ void chIQReset(Queue *qp) {
 

 /**

  * Inserts a byte into an input queue.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  * @param b the byte value to be written

  * @retval Q_OK if the operation is successful.

  * @retval Q_FULL if the queue is full.

@@ -83,7 +83,7 @@ msg_t chIQPutI(Queue *qp, uint8_t b) {
 /**

  * Gets a byte from the input queue, if the queue is empty then the

  * calling thread is suspended until a byte arrives in the queue.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  * @return A byte value from the queue.

  * @retval Q_RESET if the queue was reset.

  */

@@ -113,13 +113,13 @@ msg_t chIQGet(Queue *qp) {
  * Gets a byte from the input queue, if the queue is empty then the

  * calling thread is suspended until a byte arrives in the queue or the

  * specified time expires.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  * @param time the number of ticks before the operation timouts

  * @return A byte value from the queue.

  * @retval Q_TIMEOUT if the specified time expired.

  * @retval Q_RESET if the queue was reset.

- * @note The function is available only if the \p CH_USE_QUEUES_TIMEOUT and

- *       \p CH_USE_SEMAPHORES_TIMEOUT options are enabled in \p chconf.h.

+ * @note The function is available only if the @p CH_USE_QUEUES_TIMEOUT and

+ *       @p CH_USE_SEMAPHORES_TIMEOUT options are enabled in @p chconf.h.

  */

 msg_t chIQGetTimeout(Queue *qp, systime_t time) {

   uint8_t b;

@@ -147,7 +147,7 @@ msg_t chIQGetTimeout(Queue *qp, systime_t time) {
 /**

  * Reads some data from the input queue into the specified buffer. The function

  * is non-blocking and can return zero if the queue is empty.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  * @param buffer the data buffer

  * @param n the maximum amount of data to be read

  * @return The number of bytes read.

@@ -189,11 +189,11 @@ size_t chIQRead(Queue *qp, uint8_t *buffer, size_t n) {
 /**

  * Initializes an output queue. A Semaphore is internally initialized

  * and works as a counter of the free bytes in the queue.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  * @param buffer pointer to a memory area allocated as queue buffer

  * @param size size of the queue buffer

  * @param onotify pointer to a callback function that is invoked when

- *        some data is written in the Queue. The value can be \p NULL.

+ *        some data is written in the Queue. The value can be @p NULL.

  */

 void chOQInit(Queue *qp, uint8_t *buffer, size_t size, qnotify_t onotify) {

 

@@ -206,7 +206,7 @@ void chOQInit(Queue *qp, uint8_t *buffer, size_t size, qnotify_t onotify) {
 /**

  * Resets an Output Queue. All the data is lost and the waiting threads

  * resumed.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  */

 void chOQReset(Queue *qp) {

 

@@ -221,7 +221,7 @@ void chOQReset(Queue *qp) {
 /**

  * Inserts a byte in the output queue, if the queue is full then the thread

  * is suspended until the queue has free space available.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  * @param b the byte value to be written

  */

 void chOQPut(Queue *qp, uint8_t b) {

@@ -241,7 +241,7 @@ void chOQPut(Queue *qp, uint8_t b) {
 

 /**

  * Gets a byte from an output queue.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  * @return The byte value from the queue.

  * @retval Q_EMPTY if the queue is empty.

  * @note This function is the lower side endpoint of the output queue.

@@ -264,7 +264,7 @@ msg_t chOQGetI(Queue *qp) {
 /**

  * Writes some data from the specified buffer into the queue. The function

  * is non-blocking and can return zero if the queue is full.

- * @param qp pointer to a \p Queue structure

+ * @param qp pointer to a @p Queue structure

  * @param buffer the data buffer

  * @param n the maximum amount of data to be written

  * @return The number of written bytes.

@@ -307,13 +307,13 @@ size_t chOQWrite(Queue *qp, uint8_t *buffer, size_t n) {
 #ifdef CH_USE_QUEUES_HALFDUPLEX

  /**

  * Initializes an half duplex queue.

- * @param qp pointer to the \p HalfDuplexQueue structure

+ * @param qp pointer to the @p HalfDuplexQueue structure

  * @param buffer pointer to a memory area allocated as buffer for the queue

  * @param size the size of the queue buffer

  * @param inotify pointer to a callback function that is invoked when

- *        some data is read from the queue. The value can be \p NULL.

+ *        some data is read from the queue. The value can be @p NULL.

  * @param onotify pointer to a callback function that is invoked when

- *        some data is written to the queue. The value can be \p NULL.

+ *        some data is written to the queue. The value can be @p NULL.

  */

 void chHDQInit(HalfDuplexQueue *qp, uint8_t *buffer, size_t size,

                qnotify_t inotify, qnotify_t onotify) {

@@ -329,7 +329,7 @@ void chHDQInit(HalfDuplexQueue *qp, uint8_t *buffer, size_t size,
 /**

  * Reads a byte from the receive queue, if the queue is empty or is in

  * transmission mode then the invoking thread is suspended.

- * @param qp pointer to a \p HalfDuplexQueue structure

+ * @param qp pointer to a @p HalfDuplexQueue structure

  * @return The byte value.

  * @retval Q_RESET if the queue was reset.

  */

@@ -362,12 +362,12 @@ msg_t chHDQGetReceive(HalfDuplexQueue *qp) {
 /**

  * Reads a byte from the receive queue, if the queue is empty or is in

  * transmission mode then the invoking thread is suspended.

- * @param qp pointer to a \p HalfDuplexQueue structure

+ * @param qp pointer to a @p HalfDuplexQueue structure

  * @param time the number of ticks before the operation timouts

  * @return The byte value.

  * @retval Q_TIMEOUT if a timeout occurs.

- * @note The function is available only if the \p CH_USE_QUEUES_TIMEOUT and

- *       \p CH_USE_SEMAPHORES_TIMEOUT options are enabled in \p chconf.h.

+ * @note The function is available only if the @p CH_USE_QUEUES_TIMEOUT and

+ *       @p CH_USE_SEMAPHORES_TIMEOUT options are enabled in @p chconf.h.

  */

 msg_t chHDQGetReceiveTimeout(HalfDuplexQueue *qp, systime_t time) {

   uint8_t b;

@@ -400,7 +400,7 @@ msg_t chHDQGetReceiveTimeout(HalfDuplexQueue *qp, systime_t time) {
  * Writes a byte into the transmit queue. If the buffer contains unread

  * input data then the the buffer is cleared and the queue goes in

  * transmission mode.

- * @param qp pointer to a \p HalfDuplexQueue structure

+ * @param qp pointer to a @p HalfDuplexQueue structure

  * @param b the byte value to be written

  */

 void chHDQPutTransmit(HalfDuplexQueue *qp, uint8_t b) {

@@ -431,7 +431,7 @@ void chHDQPutTransmit(HalfDuplexQueue *qp, uint8_t b) {
 

 /**

  * Gets a byte from the transmit queue.

- * @param qp pointer to a \p HalfDuplexQueue structure

+ * @param qp pointer to a @p HalfDuplexQueue structure

  * @return The byte value.

  * @retval Q_EMPTY if the transmit queue is empty (not in transmission mode).

  * @note This function must be called with interrupts disabled or from an

@@ -453,7 +453,7 @@ msg_t chHDQGetTransmitI(HalfDuplexQueue *qp) {
 /**

  * Writes a byte into the receive queue. If the queue is in transmission mode

  * then the byte is lost.

- * @param qp pointer to a \p HalfDuplexQueue structure

+ * @param qp pointer to a @p HalfDuplexQueue structure

  * @param b the byte value to be written

  * @retval Q_OK if the operation is successful.

  * @retval Q_FULL if the driver is in transmit mode or the receive queue is full.