misc update

df_datalink_sp/src/include/circ_queue.h

@@ -45,13 +45,11 @@ typedef struct
  * @brief create a FIFO queue
  * @param queue The new queue
  * @param queue_capacity maximum size of the queue
- * @param a pool to allocate queue from
  */
 bool CircQueueCreate(CIRC_QUEUE **queue, uint32_t queue_capacity);
 
 /**
  * @brief free queue memory -- call after destroy
- * @note we do not free in destroy() to follow pthreads convention
  */
 void CircQueueFree(CIRC_QUEUE *queue);
 
@@ -72,9 +70,8 @@ bool isCircQueueEmpty(CIRC_QUEUE *queue);
  *
  * @param queue the queue
  * @param data the data
- * @return RPA_EINTR the blocking was interrupted (try again)
- * @return RPA_EOF the queue has been terminated
- * @return RPA_SUCCESS on a successful push
+ * @return True on a successful push
+ * @return False push failed
  */
 bool CircQueuePush(CIRC_QUEUE *queue, void *data);
 
@@ -83,9 +80,8 @@ bool CircQueuePush(CIRC_QUEUE *queue, void *data);
  *
  * @param queue the queue
  * @param data the data
- * @return RPA_EINTR the blocking was interrupted (try again)
- * @return RPA_EOF if the queue has been terminated
- * @return RPA_SUCCESS on a successful pop
+ * @return false pop failed
+ * @return true on a successful pop
  */
 bool CircQueuePop(CIRC_QUEUE *queue, void **data);