mixer.c: Fix doxygen \file description.
[paraslash.git] / ringbuffer.c
index bf990b0..76e2d7a 100644 (file)
@@ -1,8 +1,4 @@
-/*
- * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file ringbuffer.c Simple ringbuffer implementation */
 
 
 /** \file ringbuffer.c Simple ringbuffer implementation */
 
@@ -96,7 +92,7 @@ void *ringbuffer_get(struct ringbuffer *rb, int num)
  *
  * \param rb The ringbuffer identifier
  *
  *
  * \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)
  * size of the ring buffer.
  */
 unsigned ringbuffer_filled(struct ringbuffer *rb)