From: Andre <maan@p133.(none)>
Date: Sat, 1 Apr 2006 23:08:36 +0000 (+0200)
Subject: db.h: fix documentation
X-Git-Tag: v0.2.12~117
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=452c770acfd3aa3e1bae29ae35a62566c740e044

db.h: fix documentation

The pre_select function of struct audio_file_selector must _return_
the highest-numbered file descriptor.
---

diff --git a/db.h b/db.h
index b1368699..3b9d4530 100644
--- a/db.h
+++ b/db.h
@@ -29,8 +29,6 @@ int find_audio_files(const char *dirname, int (*f)(const char *, const char *));
  * There is one such struct for each supported selector.  During the startup
  * part of para_server the \a init() function of the activated selector gets
  * called which fills in all other function pointers.
-
- *
  *
  */
 struct audio_file_selector {
@@ -100,8 +98,8 @@ void (*shutdown)(void);
  * para_server enters its main select loop. The selector may add its own file
  * descriptors to the \a rfds or the \a wfds set.
  *
- * If a file descriptor was added, \a max_fileno must be increased by
- * this function, if neccessary.
+ * \return The highest-numbered file descriptor which was added to either of
+ * the two fd sets (or -1 if no file descriptors were added).
  *
  * \sa select(2)
  */