clarify documentation of mysql_selector_init()
authorAndre Noll <maan@systemlinux.org>
Mon, 29 Jan 2007 22:59:09 +0000 (23:59 +0100)
committerAndre Noll <maan@systemlinux.org>
Mon, 29 Jan 2007 22:59:09 +0000 (23:59 +0100)
mysql_selector.c

index 91972e8..0eb19bc 100644 (file)
@@ -2152,8 +2152,15 @@ static void shutdown_connection(void)
 /**
  * the init function of the mysql-based audio file selector
  *
- * Check the command line options and initialize all function pointers of \a db.
- * Connect to the mysql server and initialize the info string.
+ * \param db pointer to the struct to initialize
+ *
+ * Check the command line options and initialize all function pointers of \a
+ * db.  Connect to the mysql server and initialize the info string.
+ *
+ * \return This function returns success even if it could not connect
+ * to the mysql server. This is because the connect is expected to fail
+ * if there the paraslash database is not yet created. This gives the
+ * user a chance to send the "cdb" to create the database.
  *
  * \sa struct audio_file_selector, misc_meta_data::selector_info,
  * random_selector.c