From 37dd76b70c9ca6459c483653c1a1d1cc9f32237c Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Mon, 29 Jan 2007 23:59:09 +0100 Subject: [PATCH] clarify documentation of mysql_selector_init() --- mysql_selector.c | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/mysql_selector.c b/mysql_selector.c index 91972e84..0eb19bc5 100644 --- a/mysql_selector.c +++ b/mysql_selector.c @@ -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 -- 2.39.5