summaryrefslogtreecommitdiff
path: root/ringbuffer.h
diff options
context:
space:
mode:
authorKlaus Schmidinger <vdr@tvdr.de>2013-02-16 15:26:45 +0100
committerKlaus Schmidinger <vdr@tvdr.de>2013-02-16 15:26:45 +0100
commitff27cca4fea6bba863def445186fca980969cf78 (patch)
tree0e10637dc960b27669080cc528d7051d949860c5 /ringbuffer.h
parent4c827ff8a453165a9aa25d20b236a59ba0b17eef (diff)
downloadvdr-ff27cca4fea6bba863def445186fca980969cf78.tar.gz
vdr-ff27cca4fea6bba863def445186fca980969cf78.tar.bz2
Removed all \return and \param tags from comment lines marked with "///<" for Doxygen
Diffstat (limited to 'ringbuffer.h')
-rw-r--r--ringbuffer.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/ringbuffer.h b/ringbuffer.h
index 5b2eeb1c..1fff611c 100644
--- a/ringbuffer.h
+++ b/ringbuffer.h
@@ -4,7 +4,7 @@
* See the main source file 'vdr.c' for copyright information and
* how to reach the author.
*
- * $Id: ringbuffer.h 2.4 2012/09/20 09:29:32 kls Exp $
+ * $Id: ringbuffer.h 2.5 2013/02/16 15:20:37 kls Exp $
*/
#ifndef __RINGBUFFER_H
@@ -84,17 +84,17 @@ public:
///< Reads at most Max bytes from FileHandle and stores them in the
///< ring buffer. If Max is 0, reads as many bytes as possible.
///< Only one actual read() call is done.
- ///< \return Returns the number of bytes actually read and stored, or
+ ///< Returns the number of bytes actually read and stored, or
///< an error value from the actual read() call.
int Read(cUnbufferedFile *File, int Max = 0);
///< Like Read(int FileHandle, int Max), but reads from a cUnbufferedFile).
int Put(const uchar *Data, int Count);
///< Puts at most Count bytes of Data into the ring buffer.
- ///< \return Returns the number of bytes actually stored.
+ ///< Returns the number of bytes actually stored.
uchar *Get(int &Count);
///< Gets data from the ring buffer.
///< The data will remain in the buffer until a call to Del() deletes it.
- ///< \return Returns a pointer to the data, and stores the number of bytes
+ ///< Returns a pointer to the data, and stores the number of bytes
///< actually available in Count. If the returned pointer is NULL, Count has no meaning.
void Del(int Count);
///< Deletes at most Count bytes from the ring buffer.