[sr-dev] git:master:cab20219: db_postgres: doxygen fixes

[Henning Westerholt]

Module: kamailio
Branch: master
Commit: cab2021913eb597812bde529d697f931aa885e82
URL: https://github.com/kamailio/kamailio/commit/cab2021913eb597812bde529d697f931aa885e82

Author: Henning Westerholt <hw at kamailio.org>
Committer: Henning Westerholt <hw at kamailio.org>
Date: 2018-03-14T21:46:26+01:00

db_postgres: doxygen fixes

---

Modified: src/modules/db_postgres/km_dbase.c

---

Diff:  https://github.com/kamailio/kamailio/commit/cab2021913eb597812bde529d697f931aa885e82.diff
Patch: https://github.com/kamailio/kamailio/commit/cab2021913eb597812bde529d697f931aa885e82.patch

---

diff --git a/src/modules/db_postgres/km_dbase.c b/src/modules/db_postgres/km_dbase.c
index b9c1115e19..ea9468295a 100644
--- a/src/modules/db_postgres/km_dbase.c
+++ b/src/modules/db_postgres/km_dbase.c
@@ -103,7 +103,7 @@ static void db_postgres_free_query(const db1_con_t *_con);
 
 
 /*!
- * \brief Initialize database for future queries
+ * \brief Initialize database for future queries, with pooling
  * \param _url URL of the database that should be opened
  * \return database connection on success, NULL on error
  * \note this function must be called prior to any database functions
@@ -114,8 +114,9 @@ db1_con_t *db_postgres_init(const str *_url)
 }
 
 /*!
- * \brief Initialize database for future queries - no pooling
+ * \brief Initialize database for future queries, specify pooling
  * \param _url URL of the database that should be opened
+ * \param pooling whether or not to use a pooled connection
  * \return database connection on success, NULL on error
  * \note this function must be called prior to any database functions
  */
@@ -649,7 +650,7 @@ static pg_constraint_t *pg_constraint = NULL;
 
 /*!
  * \brief add/save a detected constraint to the list in memory
- * \param pg_constraint_t constraint
+ * \param c database constraint structure
  */
 static void db_postgres_constraint_add(pg_constraint_t *c)
 {
@@ -930,6 +931,7 @@ int db_postgres_affected_rows(const db1_con_t *_h)
 /**
  * Starts a single transaction that will consist of one or more queries (SQL BEGIN)
  * \param _h database handle
+ * \param _l database locking , supports no locking, write locking or full locking
  * \return 0 on success, negative on failure
  */
 int db_postgres_start_transaction(db1_con_t *_h, db_locking_t _l)