- fix database related doxygen errors

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@4398 689a6050-402a-0410-94f2-e92a70836424

lib/srdb1/db.h

@@ -71,7 +71,7 @@ typedef int (*db_use_table_f)(db_con_t* _h, const str * _t);
  * 
  * The function takes one parameter, the parameter must contain the database
  * connection URL. The URL is of the form 
- * mysql://username:password@host:port/database where:
+ * mysql://username:password\@host:port/database where:
  * 
  * username: Username to use when logging into database (optional).
  * password: password if it was set (optional)
@@ -362,7 +362,7 @@ int db_table_version(const db_func_t* dbf, db_con_t* con, const str* table);
  *
  * Small helper function to check the table version.
  * \param dbf database module callbacks
- * \param con database connection handle
+ * \param dbh database connection handle
  * \param table checked table
  * \param \version checked version
  * \return 0 means ok, -1 means an error occured

lib/srdb1/db_id.c

@@ -36,6 +36,9 @@
 
 /**
  * Duplicate a string
+ * \param dst destination
+ * \param begin start of the string
+ * \param end end of the string
  */
 static int dupl_string(char** dst, const char* begin, const char* end)
 {
@@ -56,8 +59,8 @@ static int dupl_string(char** dst, const char* begin, const char* end)
  * Parse a database URL of form 
  * scheme://[username[:password]@]hostname[:port]/database
  *
- * \param id that should be filled
- * \param parsed url
+ * \param id filled id struct
+ * \param url parsed URL
  * \return 0 if parsing was successful and -1 otherwise
  */
 static int parse_db_url(struct db_id* id, const str* url)
@@ -212,8 +215,10 @@ static int parse_db_url(struct db_id* id, const str* url)
 }
 
 
-/*
+/**
  * Create a new connection identifier
+ * \param url database URL
+ * \return connection identifier, or zero on error
  */
 struct db_id* new_db_id(const str* url)
 {
@@ -244,8 +249,11 @@ struct db_id* new_db_id(const str* url)
 }
 
 
-/*
+/**
  * Compare two connection identifiers
+ * \param id1 first identifier
+ * \param id2 second identifier
+ * \return one if both are equal, zero otherwise
  */
 unsigned char cmp_db_id(const struct db_id* id1, const struct db_id* id2)
 {
@@ -265,8 +273,9 @@ unsigned char cmp_db_id(const struct db_id* id1, const struct db_id* id2)
 }
 
 
-/*
+/**
  * Free a connection identifier
+ * \param id identifier
  */
 void free_db_id(struct db_id* id)
 {

lib/srdb1/db_query.h

@@ -83,7 +83,6 @@ int db_do_query(const db_con_t* _h, const db_key_t* _k, const db_op_t* _op,
  * \param _h structure representing database connection
  * \param _s char holding the raw query
  * \param _r the result that is returned
- * \param (*val2str) function pointer to the db specific val conversion function
  * \param (*submit_query) function pointer to the db specific query submit function
  * \param (*store_result) function pointer to the db specific store result function
  * \return zero on success, negative on errors
@@ -175,7 +174,6 @@ int db_do_update(const db_con_t* _h, const db_key_t* _k, const db_op_t* _o,
  * \param _k key names, if not present the whole table will be returned
  * \param _v values of the keys that must match
  * \param _n number of key/value pairs that are compared, if zero then no comparison is done
- * \param _un: number of columns that should be updated
  * \param (*val2str) function pointer to the db specific val conversion function
  * \param (*submit_query) function pointer to the db specific query submit function
  * \return zero on success, negative on errors