chiark / gitweb /
doxygen fixes
authorRichard Kettlewell <rjk@greenend.org.uk>
Mon, 19 Nov 2007 16:05:06 +0000 (16:05 +0000)
committerRichard Kettlewell <rjk@greenend.org.uk>
Mon, 19 Nov 2007 16:05:06 +0000 (16:05 +0000)
Doxyfile
disobedience/misc.c
disobedience/queue.c
lib/event.c
server/play.c

index 3c5bb5b560f11f77ba09fef3a107fbf28c2a6f6c..e2eca1d244796495928983ad1ed82113d551f0ca 100644 (file)
--- 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 
index 958e2b2c34b1e84e80371205f0d05d81723445ff..b1558d341c291eb3fd48388c04465478245ef95f 100644 (file)
@@ -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) {
index 2469f25158857016a083c03f281f9437ab9c37ae..fb1b73ea2df15219ab4c708005fb1e3ae16af142 100644 (file)
@@ -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
  */
index 56278f6882188d8a6fb0542142bc3c6547ed59c8..3618bf41c7b4e4e9cd853339f597361f512f1694 100644 (file)
@@ -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
index f0ac386276922c718eea411a9abbb1889c54d041..04d7d0117d54f2508560fa3ba1fa0b19e2940827 100644 (file)
@@ -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,