From 434b32087a9e2d54ca88072ca798a703a2ff629f Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sat, 7 Jul 2007 20:21:48 +0200 Subject: [PATCH 1/1] trivial doxygen cleanups Replace @param by \param and fix punctuation. --- afs.c | 13 ++++++----- ringbuffer.c | 61 ++++++++++++++++++++-------------------------------- 2 files changed, 29 insertions(+), 45 deletions(-) diff --git a/afs.c b/afs.c index 2b7b9ee9..13a9ccb2 100644 --- a/afs.c +++ b/afs.c @@ -5,7 +5,7 @@ */ -/** \file afs.c functions common to all audio file selectors */ +/** \file afs.c Functions common to all audio file selectors. */ #include "server.cmdline.h" #include "server.h" @@ -17,12 +17,12 @@ #include "string.h" /** - * traverse the given directory recursively + * Traverse the given directory recursively. * - * @param dirname the directory to traverse - * @param f: the function to call for each entry. + * \param dirname The directory to traverse. + * \param f The function to call for each entry. * - * for each regular file whose filename ends in .yyy, where yyy is a supported + * For each regular file whose filename ends in .yyy, where yyy is a supported * audio format, the supplied function \a f is called. The directory and * filename component of the regular file are passed to \a f. * @@ -40,9 +40,8 @@ int find_audio_files(const char *dirname, int (*f)(const char *, const char *)) */ int cwd_fd = open(".", O_RDONLY); struct stat s; - int ret = -1; + int ret; -// PARA_DEBUG_LOG("dirname: %s\n", dirname); if (cwd_fd < 0) return -E_GETCWD; ret = -E_CHDIR; diff --git a/ringbuffer.c b/ringbuffer.c index f6596daf..17ea425a 100644 --- a/ringbuffer.c +++ b/ringbuffer.c @@ -1,51 +1,36 @@ /* - * Copyright (C) 2006 Andre Noll + * Copyright (C) 2006-2007 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ -/** \file ringbuffer.c simple ringbuffer implementation */ +/** \file ringbuffer.c Simple ringbuffer implementation */ #include "para.h" #include "ringbuffer.h" #include "string.h" /** - * holds all information about one ring buffer + * Holds all information about one ring buffer * * It is intentionally not exported via ringbuffer.h. Think abstract. */ struct ringbuffer { -/** - * - * - * the size of this ring buffer -*/ -unsigned size; -/** - * - * - * the actual entries of the ringbuffer -*/ -void **entries; -/** - * - * - * the next entry will be added at this position - */ -int head; -/** - * - * how many entries the ring buffer contains -*/ -unsigned filled; + /** The size of this ring buffer. */ + unsigned size; + /** The actual entries of the ringbuffer. */ + void **entries; + /** The next entry will be added at this position. */ + int head; + /** How many entries the ring buffer contains. */ + unsigned filled; }; /** - * initialize a new ringbuffer + * Initialize a new ringbuffer. * - * @param size the number of entries the ringbuffer holds + * \param size The number of entries the ringbuffer holds. * * This function initializes a circular ring buffer which can hold up to \a * size entries of arbitrary type. If performance is an issue, \a size should @@ -53,7 +38,7 @@ unsigned filled; * many ringbuffers may be initialized via this function. Each ringbuffer is * identified by a 'cookie'. * - * Return value: A 'cookie' which identifies the ringbuffer just created and + * \return A 'cookie' which identifies the ringbuffer just created and * which must be passed to ringbuffer_add() and ringbuffer_get(). */ void *ringbuffer_new(unsigned size) @@ -65,12 +50,12 @@ void *ringbuffer_new(unsigned size) }; /** - * add one entry to a ringbuffer + * Add one entry to a ringbuffer. * - * @param cookie the ringbuffer identifier - * @param data the data to be inserted + * \param Cookie the ringbuffer identifier. + * \param Data the data to be inserted. * - * insert \a data into the ringbuffer associated with \a cookie. As soon as + * Insert \a data into the ringbuffer associated with \a cookie. As soon as * the ringbuffer fills up, its oldest entry is disregarded and replaced by \a * data. * @@ -89,10 +74,10 @@ void *ringbuffer_add(void *cookie, void *data) } /** - * get one entry from a ringbuffer + * Get one entry from a ringbuffer. * - * @param cookie the ringbuffer identifier - * @param num the number of the entry + * \param cookie The ringbuffer identifier. + * \param num The number of the entry. * * \return A pointer to data previously added, or NULL if entry number * \a num is not available. \a num counts backwards from zero, i.e. @@ -107,9 +92,9 @@ void *ringbuffer_get(void *cookie, int num) } /** - * get the number of entries in the ring buffer + * Get the number of entries in the ring buffer. * - * @param cookie the ringbuffer identifier + * \param cookie The ringbuffer identifier * * This function always succeeds and never returns a number greater than the * size of the ring buffer. -- 2.30.2