X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=ringbuffer.c;h=15d767e67d6bcb7e99a4c84f59ba2376f530c9e0;hp=b27fd8e8a25c4ccd52756f2e9c0f30e1c3b4162b;hb=a7a72ca4acf7f44abca866d410e2bc80590e7fab;hpb=ce6b826b855d3760324a46d0687ddb4a110aa890 diff --git a/ringbuffer.c b/ringbuffer.c index b27fd8e8..15d767e6 100644 --- a/ringbuffer.c +++ b/ringbuffer.c @@ -1,11 +1,13 @@ /* - * Copyright (C) 2006-2009 Andre Noll + * Copyright (C) 2006-2011 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ /** \file ringbuffer.c Simple ringbuffer implementation */ +#include + #include "para.h" #include "ringbuffer.h" #include "string.h" @@ -94,7 +96,7 @@ void *ringbuffer_get(struct ringbuffer *rb, int num) * * \param rb The ringbuffer identifier * - * This function always succeeds and never returns a number greater than the + * \return This function always succeeds. It returns a number less than the * size of the ring buffer. */ unsigned ringbuffer_filled(struct ringbuffer *rb)