From 158d096132f284c409fe1954457c67d77caf796c Mon Sep 17 00:00:00 2001 Message-Id: <158d096132f284c409fe1954457c67d77caf796c.1716834561.git.mdw@distorted.org.uk> From: Mark Wooding Date: Sun, 23 Dec 2007 12:38:21 +0000 Subject: [PATCH] doxygen cleanup Organization: Straylight/Edgeware From: rjk@greenend.org.uk <> --- clients/playrtp-oss.c | 2 +- lib/base64.c | 1 + lib/client.c | 9 ++++----- lib/client.h | 2 +- lib/mime.c | 8 +++++--- lib/selection.h | 2 +- lib/trackdb.c | 11 ++++++----- 7 files changed, 19 insertions(+), 16 deletions(-) diff --git a/clients/playrtp-oss.c b/clients/playrtp-oss.c index b40947d..15f6b53 100644 --- a/clients/playrtp-oss.c +++ b/clients/playrtp-oss.c @@ -189,7 +189,7 @@ static void playrtp_oss_disable(int hard) { /** @brief Write samples to OSS output device * @param data Pointer to sample data - * @param nsamples Number of samples + * @param samples Number of samples * @return 0 on success, non-0 on error */ static int playrtp_oss_write(const char *data, size_t samples) { diff --git a/lib/base64.c b/lib/base64.c index 1a0dca2..c657cde 100644 --- a/lib/base64.c +++ b/lib/base64.c @@ -37,6 +37,7 @@ static const char mime_base64_table[] = /** @brief Convert MIME base64 * @param s base64 data + * @param nsp Where to store length of converted data * @return Decoded data * * See RFC diff --git a/lib/client.c b/lib/client.c index 8147c6d..b7292c5 100644 --- a/lib/client.c +++ b/lib/client.c @@ -20,7 +20,7 @@ /** @file lib/client.c * @brief Simple C client * - * See @file lib/eclient.c for an asynchronous-capable client + * See @ref lib/eclient.c for an asynchronous-capable client * implementation. */ @@ -735,7 +735,7 @@ static void pref_error_handler(const char *msg, error(0, "error handling 'prefs' reply: %s", msg); } -/** @param Get all preferences for a trcak +/** @brief Get all preferences for a trcak * @param c Client * @param track Track name * @param kp Where to store linked list of preferences @@ -859,7 +859,7 @@ int disorder_random_disable(disorder_client *c) { /** @brief Test whether random play is enabled * @param c Client - * @param existsp Where to store result (non-0 iff enabled) + * @param enabledp Where to store result (non-0 iff enabled) * @return 0 on success, non-0 on error */ int disorder_random_enabled(disorder_client *c, int *enabledp) { @@ -949,7 +949,7 @@ int disorder_part(disorder_client *c, char **partp, /** @brief Resolve aliases * @param c Client - * @param trackkp Where to store canonical name (UTF-8) + * @param trackp Where to store canonical name (UTF-8) * @param track Track name (UTF-8) * @return 0 on success, non-0 on error */ @@ -1118,7 +1118,6 @@ int disorder_edituser(disorder_client *c, const char *user, * @param user Username * @param password Password * @param email Email address (UTF-8) - * @param rights Initial rights or NULL to use default * @param confirmp Where to store confirmation string * @return 0 on success, non-0 on error */ diff --git a/lib/client.h b/lib/client.h index 18c308b..7d6a47e 100644 --- a/lib/client.h +++ b/lib/client.h @@ -20,7 +20,7 @@ /** @file lib/client.h * @brief Simple C client * - * See @file lib/eclient.h for an asynchronous-capable client + * See @ref lib/eclient.h for an asynchronous-capable client * implementation. */ diff --git a/lib/mime.c b/lib/mime.c index a97c4d1..7ba4254 100644 --- a/lib/mime.c +++ b/lib/mime.c @@ -107,7 +107,9 @@ static int iscrlf(const char *ptr) { } /** @brief Skip whitespace + * @param s Pointer into string * @param rfc822_comments If true, skip RFC822 nested comments + * @return Pointer into string after whitespace */ static const char *skipwhite(const char *s, int rfc822_comments) { int c, depth; @@ -207,7 +209,7 @@ static const char *parsetoken(const char *s, char **valuep, * @param s Start of field * @param typep Where to store type * @param parameternamep Where to store parameter name - * @param parameternvaluep Wher to store parameter value + * @param parametervaluep Wher to store parameter value * @return 0 on success, non-0 on error * * See RFC 2045 s5. @@ -360,9 +362,9 @@ int mime_multipart(const char *s, /** @brief Parse an RFC2388-style content-disposition field * @param s Start of field - * @param typep Where to store type + * @param dispositionp Where to store disposition * @param parameternamep Where to store parameter name - * @param parameternvaluep Wher to store parameter value + * @param parametervaluep Wher to store parameter value * @return 0 on success, non-0 on error * * See RFC 2388 s3 diff --git a/lib/selection.h b/lib/selection.h index 9089649..6618b17 100644 --- a/lib/selection.h +++ b/lib/selection.h @@ -17,7 +17,7 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA */ -/** @file lib/selection.c +/** @file lib/selection.h * @brief Select management for Disobedience */ diff --git a/lib/trackdb.c b/lib/trackdb.c index e030665..648189f 100644 --- a/lib/trackdb.c +++ b/lib/trackdb.c @@ -17,7 +17,7 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA */ -/** @file server/trackdb.c +/** @file lib/trackdb.c * @brief Track database * * This file is getting in desparate need of splitting up... @@ -113,7 +113,7 @@ DB *trackdb_prefsdb; * - Values are UTF-8(NFC(unicode(path name))) * - There can be more than one value per key * - Presence of key,value means that path matches the search terms - * - Only tracks fond in @ref tracks_tracksdb are represented here + * - Only tracks fond in @ref trackdb_tracksdb are represented here * - This database can be reconstructed, it contains no user data */ DB *trackdb_searchdb; @@ -349,7 +349,7 @@ static DB *open_db(const char *path, } /** @brief Open track databases - * @param Flags flags word + * @param flags Flags flags word * * @p flags should have one of: * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted @@ -2574,7 +2574,8 @@ const char *trackdb_get_password(const char *user) { * @param user Username * @param password Password or NULL * @param rights Initial rights - * @param email Email address + * @param email Email address or NULL + * @param confirmation Confirmation string or NULL * @return 0 on success, non-0 on error */ int trackdb_adduser(const char *user, @@ -2601,7 +2602,7 @@ int trackdb_adduser(const char *user, /** @brief Delete a user * @param user User to delete - * @param 0 on success, non-0 if the user didn't exist anyway + * @return 0 on success, non-0 if the user didn't exist anyway */ int trackdb_deluser(const char *user) { int e; -- [mdw]