From 3e98ae3c55d4135d56b3a9c2c5429ebba3f51a69 Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: 周二, 13 10月 2015 00:24:37 +0800
Subject: [PATCH] Cleanup of matchCommand

---
 libscpi/src/fifo.c |   28 +++++++++++++++++++++++++++-
 1 files changed, 27 insertions(+), 1 deletions(-)

diff --git a/libscpi/src/fifo.c b/libscpi/src/fifo.c
index 7011030..a69cf85 100644
--- a/libscpi/src/fifo.c
+++ b/libscpi/src/fifo.c
@@ -1,17 +1,31 @@
 
 #include "fifo_private.h"
 
+/**
+ * Initialize fifo
+ * @param fifo
+ */
 void fifo_init(scpi_fifo_t * fifo) {
     fifo->wr = 0;
     fifo->rd = 0;
     fifo->size = FIFO_SIZE;
 }
 
+/**
+ * Empty fifo
+ * @param fifo
+ */
 void fifo_clear(scpi_fifo_t * fifo) {
     fifo->wr = 0;
     fifo->rd = 0;
 }
 
+/**
+ * Add element to fifo. If fifo is full, remove last element.
+ * @param fifo
+ * @param value
+ * @return 
+ */
 scpi_bool_t fifo_add(scpi_fifo_t * fifo, int16_t value) {
     /* FIFO full? */
     if (fifo->wr == ((fifo->rd + fifo->size) % (fifo->size + 1))) {
@@ -24,13 +38,19 @@
     return TRUE;
 }
 
+/**
+ * Remove element form fifo
+ * @param fifo
+ * @param value
+ * @return FALSE - fifo is empty
+ */
 scpi_bool_t fifo_remove(scpi_fifo_t * fifo, int16_t * value) {
     /* FIFO empty? */
     if (fifo->wr == fifo->rd) {
         return FALSE;
     }
 
-    if(value) {
+    if (value) {
         *value = fifo->data[fifo->rd];
     }
 
@@ -39,6 +59,12 @@
     return TRUE;
 }
 
+/**
+ * Retrive number of elements in fifo
+ * @param fifo
+ * @param value
+ * @return 
+ */
 scpi_bool_t fifo_count(scpi_fifo_t * fifo, int16_t * value) {
     *value = fifo->wr - fifo->rd;
     if (*value < 0) {

--
Gitblit v1.9.1