X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=db.h;h=b136869952eace5d5b05886f2179f2c4a2280245;hp=578e4fd9f8ba33ef7626832cb58eb9655ee2d8cd;hb=68f5f7bdb30e7adcb87d0f314c67f0f80b337306;hpb=019a4caa2bf9232c7efd84ffe7424994de6358fb

diff --git a/db.h b/db.h
index 578e4fd9..b1368699 100644
--- a/db.h
+++ b/db.h
@@ -24,34 +24,34 @@
 int find_audio_files(const char *dirname, int (*f)(const char *, const char *));
 
 /**
- * describes one of para_server's supported database tools
+ * describes one supported audio file selector
  *
- * There is exactly one such struct for each supported database tool.  During
- * the startup part of para_server the \a init() function of the activated
- * database tool gets called which fills in the other members.
+ * 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 {
 /**
- * name name of this database tool
+ * name name of this selector
  */
 const char *name;
 /**
- * the database init routine
+ * the init routine of the selector
  *
  * It should check its command line options and do all necessary initialization
  * like connecting to a database server.
  *
  * A negative return value indicates an initialization error and means that
- * this database tool should be ignored for now (it may later be activated
- * again via the cdt command).
+ * this selector should be ignored for now (it may later be activated again via
+ * the chs command).
  *
  * If \a init() returns success (non-negative return value), it must have
  * initialized in all non-optional function pointers of the given selector
  * struct. Moreover, \a cmd_list must point to a NULL-terminated array which
- * holds the list of all commands that are supported by this database tool.
+ * holds the list of all commands that are supported by this selector.
  */
 int (*init)(struct audio_file_selector *self);
 /**
@@ -84,20 +84,21 @@ char **(*get_audio_file_list)(unsigned int num);
 void (*update_audio_file)(char *audio_file);
 /**
  *
- * shutdown this database tool and free all resources
+ * shutdown this selector and free all resources
  *
- * This gets called whenever the database tool changes (via the cdt command),
- * or when para_server receives the HUP signal, or when para_server shuts down.
- * It is assumed to succeed.
+ * This gets called whenever the audio file selector changes. The reason for
+ * this change might be that some user sent the chs command, that para_server
+ * receives the HUP signal, or that para_server shuts down. It is assumed to
+ * succeed.
  */
 void (*shutdown)(void);
 /**
  *
  * add file descriptors to fd_sets
  *
- * The pre_select function of the activated database tool gets called just
- * before para_server enters its main select loop. The selector may add its own
- * file descriptors to the \a rfds or the \a wfds set.
+ * The pre_select function of the activated selector gets called just before
+ * 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.