From 3149c1e2b844685497d87db1a031197527101766 Mon Sep 17 00:00:00 2001 Message-Id: <3149c1e2b844685497d87db1a031197527101766.1713547153.git.mdw@distorted.org.uk> From: Mark Wooding Date: Mon, 19 Nov 2007 16:05:06 +0000 Subject: [PATCH] doxygen fixes Organization: Straylight/Edgeware From: Richard Kettlewell --- Doxyfile | 2 +- disobedience/misc.c | 2 +- disobedience/queue.c | 2 +- lib/event.c | 4 ++-- server/play.c | 8 ++++---- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Doxyfile b/Doxyfile index 3c5bb5b..e2eca1d 100644 --- a/Doxyfile +++ b/Doxyfile @@ -480,7 +480,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = disobedience/images.h # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/disobedience/misc.c b/disobedience/misc.c index 958e2b2..b1558d3 100644 --- a/disobedience/misc.c +++ b/disobedience/misc.c @@ -137,7 +137,7 @@ void fpopup_msg(GtkMessageType mt, const char *fmt, ...) { /** @brief Create a button with an icon in it * @param path (relative) path to image - * @param tooltip Tooltip or NULL to not set one + * @param tip Tooltip or NULL to not set one * @return Button */ GtkWidget *iconbutton(const char *path, const char *tip) { diff --git a/disobedience/queue.c b/disobedience/queue.c index 2469f25..fb1b73e 100644 --- a/disobedience/queue.c +++ b/disobedience/queue.c @@ -508,7 +508,7 @@ static void update_queue(struct queuelike *ql, struct queue_entry *newq) { /** @brief Wrap up a widget for putting into the queue or title * @param label Label to contain - * @param color Pointer to color + * @param style Pointer to style to use * @param wp Updated with maximum width (or NULL) * @return New widget */ diff --git a/lib/event.c b/lib/event.c index 56278f6..3618bf4 100644 --- a/lib/event.c +++ b/lib/event.c @@ -161,7 +161,7 @@ static inline int gt(const struct timeval *a, const struct timeval *b) { /** @brief Greater-than-or-equal comparison for timevals * - * Ought to be in @file lib/timeval.h + * Ought to be in @ref lib/timeval.h */ static inline int ge(const struct timeval *a, const struct timeval *b) { return !gt(b, a); @@ -455,7 +455,7 @@ void ev_report(ev_source *ev) { /** @brief Register a timeout * @param ev Event source - * @param handle Where to store timeout handle, or @c NULL + * @param handlep Where to store timeout handle, or @c NULL * @param when Earliest time to call @p callback, or @c NULL * @param callback Function to call at or after @p when * @param u Passed to @p callback diff --git a/server/play.c b/server/play.c index f0ac386..04d7d01 100644 --- a/server/play.c +++ b/server/play.c @@ -285,15 +285,15 @@ static int find_player(const struct queue_entry *q) { } /* Return values from start() */ -#define START_OK 0 /* Succeeded. */ -#define START_HARDFAIL 1 /* Track is broken. */ -#define START_SOFTFAIL 2 /* Track OK, system (temporarily?) broken */ +#define START_OK 0 /**< @brief Succeeded. */ +#define START_HARDFAIL 1 /**< @brief Track is broken. */ +#define START_SOFTFAIL 2 /**< @brief Track OK, system (temporarily?) broken */ /** @brief Play or prepare @p q * @param ev Event loop * @param q Track to play/prepare * @param prepare_only If true, only prepares track - * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFTAIL + * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL */ static int start(ev_source *ev, struct queue_entry *q, -- [mdw]