[SR-Dev] git:janakj/mysql: - fix a few errors in doxygen documentation

Module: sip-router Branch: janakj/mysql Commit: 5ffb6c9ef29a1d02401e0986a0aff058d339338d URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=5ffb6c9… Author: Henning Westerholt <henning.westerholt(a)1und1.de> Committer: Henning Westerholt <henning.westerholt(a)1und1.de> Date: Tue Nov 25 09:34:15 2008 +0000 - fix a few errors in doxygen documentation - sync one function definitions variables with declaration git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@5254 689a6050-402a-0410-94f2-e92a70836424 --- modules/db_mysql/km_res.c | 24 ++++++++++++++++++------ modules/db_mysql/km_res.h | 16 +++++++++++++--- modules/db_mysql/km_row.c | 8 ++++++-- modules/db_mysql/km_row.h | 10 +++++++--- 4 files changed, 44 insertions(+), 14 deletions(-) diff --git a/modules/db_mysql/km_res.c b/modules/db_mysql/km_res.c index cf1e261..13a5c9b 100644 --- a/modules/db_mysql/km_res.c +++ b/modules/db_mysql/km_res.c @@ -41,8 +41,14 @@ #include "res.h" -/*! \brief - * Get and convert columns from a result +/*! + * \brief Get and convert columns from a result + * + * Get and convert columns from a result, fills the result structure + * with data from the database. + * \param _h database connection + * \param _r database result set + * \return 0 on success, negative on failure */ int db_mysql_get_columns(const db_con_t* _h, db_res_t* _r) { @@ -143,8 +149,11 @@ int db_mysql_get_columns(const db_con_t* _h, db_res_t* _r) } -/*! \brief - * Convert rows from mysql to db API representation +/*! + * \brief Convert rows from mysql to db API representation + * \param _h database connection + * \param _r database result set + * \return 0 on success, negative on failure */ static inline int db_mysql_convert_rows(const db_con_t* _h, db_res_t* _r) { @@ -190,8 +199,11 @@ static inline int db_mysql_convert_rows(const db_con_t* _h, db_res_t* _r) } -/*! \brief - * Fill the structure with data from database +/*! + * \brief Fill the result structure with data from database + * \param _h database connection + * \param _r database result + * \return 0 on success, negative on failure */ int db_mysql_convert_result(const db_con_t* _h, db_res_t* _r) { diff --git a/modules/db_mysql/km_res.h b/modules/db_mysql/km_res.h index 051c037..4bded19 100644 --- a/modules/db_mysql/km_res.h +++ b/modules/db_mysql/km_res.h @@ -38,11 +38,21 @@ #include "../../db/db_con.h" -/* - * Fill the structure with data from database +/*! + * \brief Fill the result structure with data from database + * \param _h database connection + * \param _r database result + * \return 0 on success, negative on failure */ int db_mysql_convert_result(const db_con_t* _h, db_res_t* _r); + +/*! + * \brief Get and convert columns from a result + * \param _h database connection + * \param _r database result set + * \return 0 on success, negative on failure + */ int db_mysql_get_columns(const db_con_t* _h, db_res_t* _r); -#endif /* RES_H */ +#endif diff --git a/modules/db_mysql/km_row.c b/modules/db_mysql/km_row.c index 62b9ae8..c623198 100644 --- a/modules/db_mysql/km_row.c +++ b/modules/db_mysql/km_row.c @@ -37,8 +37,12 @@ #include "val.h" #include "row.h" -/*! \brief - * Convert a row from result into db API representation +/*! + * \brief Convert a row from result into DB API representation + * \param _h database connection + * \param _res database result in the DB API representation + * \param _r database result row + * \return 0 on success, -1 on failure */ int db_mysql_convert_row(const db_con_t* _h, db_res_t* _res, db_row_t* _r) { diff --git a/modules/db_mysql/km_row.h b/modules/db_mysql/km_row.h index 52fd489..068f05e 100644 --- a/modules/db_mysql/km_row.h +++ b/modules/db_mysql/km_row.h @@ -39,9 +39,13 @@ #include "../../db/db_row.h" -/** - * Convert a row from result into db API representation +/*! + * \brief Convert a row from result into DB API representation + * \param _h database connection + * \param _res database result in the DB API representation + * \param _r database result row + * \return 0 on success, -1 on failure */ int db_mysql_convert_row(const db_con_t* _h, db_res_t* _res, db_row_t* _r); -#endif /* ROW_H */ +#endif