From 572fe661c3069a86c1725202c27ce1d69d6530d2 Mon Sep 17 00:00:00 2001 From: skarg Date: Sat, 11 Aug 2007 17:15:43 +0000 Subject: [PATCH] Updated comments. --- bacnet-stack/ringbuf.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/bacnet-stack/ringbuf.c b/bacnet-stack/ringbuf.c index 5ebe12af..c5675d1b 100644 --- a/bacnet-stack/ringbuf.c +++ b/bacnet-stack/ringbuf.c @@ -33,7 +33,7 @@ ------------------------------------------- ####COPYRIGHTEND####*/ -/* Functional Description: Generic ring buffer library for deeply +/* Functional Description: Generic ring buffer library for deeply embedded system. See the unit tests for usage examples. */ #include @@ -53,7 +53,7 @@ bool Ringbuf_Empty(RING_BUFFER const *b) /**************************************************************************** * DESCRIPTION: Looks at the data from the head of the list without removing it -* RETURN: none +* RETURN: pointer to the data, or NULL if nothing in the list * ALGORITHM: none * NOTES: none *****************************************************************************/ @@ -64,7 +64,7 @@ char *Ringbuf_Get_Front(RING_BUFFER const *b) /**************************************************************************** * DESCRIPTION: Gets the data from the front of the list, and removes it -* RETURN: none +* RETURN: pointer to the data, or NULL if nothing in the list * ALGORITHM: none * NOTES: none *****************************************************************************/