From dc3bbfa529d9eb9151fdc4119983e8bdf23f751d Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 11 Mar 2007 19:19:09 +0100 Subject: [PATCH] small documentation cleanup --- afh.h | 2 +- fd.c | 15 +++++++++++++-- server.h | 1 + vss.c | 7 +------ 4 files changed, 16 insertions(+), 9 deletions(-) diff --git a/afh.h b/afh.h index 69c1188e..daac3279 100644 --- a/afh.h +++ b/afh.h @@ -70,7 +70,7 @@ struct audio_format_info { * file header. */ char *header; - /* the length of the header, ignored if \a header is \p NULL */ + /** the length of the header, ignored if \a header is \p NULL */ unsigned header_len; }; diff --git a/fd.c b/fd.c index df7921b4..637884b4 100644 --- a/fd.c +++ b/fd.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2006 Andre Noll + * Copyright (C) 2006-2007 Andre Noll * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -167,8 +167,19 @@ again: goto again; } +/** + * paralash's wrapper for fseek(3) + * + * \param stream stream to seek + * \param offset added to the position specified by whence + * \param whence \p SEEK_SET, \p SEEK_CUR, or \p SEEK_END + * + * \return positive on success, -E_FSEEK on errors. + * + * \sa fseek(3) + */ int para_fseek(FILE *stream, long offset, int whence) { int ret = fseek(stream, offset, whence); - return ret < 0? -E_FSEEK : ret; + return ret < 0? -E_FSEEK : 1; } diff --git a/server.h b/server.h index efee2dbd..b33ba1dd 100644 --- a/server.h +++ b/server.h @@ -74,6 +74,7 @@ struct sender_command_data{ * date. */ struct misc_meta_data { +/** information on the current audio file */ struct audio_format_info afi; /** the size of the current audio file in bytes */ long unsigned int size; diff --git a/vss.c b/vss.c index 12247606..1bb6ff86 100644 --- a/vss.c +++ b/vss.c @@ -505,12 +505,10 @@ again: /** * read a chunk of data from the current audio file * - * \param current_chunk the chunk number to read - * * \return The length of the chunk on success, zero on end of file, negative on * errors. Note: If the current chunk is of length zero, but the end of the * file is not yet reached, this function returns -E_EMPTY_CHUNK. - * */ + */ ssize_t vss_read_chunk(void) { ssize_t len; @@ -544,9 +542,6 @@ ssize_t vss_read_chunk(void) * the current audio format handler to obtain a pointer to the data to be * sent out as well as its length. This information is then passed to each * supported sender's send() function which does the actual sending. - * - * Return value: Positive return value on success, zero on eof and negative - * on errors. */ void vss_send_chunk(void) { -- 2.39.5