[sr-dev] git:master:841ae832: db_berkeley: doxygen fixes

[Henning Westerholt]

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

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

db_berkeley: doxygen fixes

---

Modified: src/modules/db_berkeley/bdb_cmd.c
Modified: src/modules/db_berkeley/bdb_cmd.h

---

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

---

diff --git a/src/modules/db_berkeley/bdb_cmd.c b/src/modules/db_berkeley/bdb_cmd.c
index 0b5c062ac5..142d86f39c 100644
--- a/src/modules/db_berkeley/bdb_cmd.c
+++ b/src/modules/db_berkeley/bdb_cmd.c
@@ -61,6 +61,11 @@ static void bdb_cmd_free(db_cmd_t *cmd, bdb_cmd_t *payload)
 	pkg_free(payload);
 }
 
+/** Prepare a query
+ * @param cmd DB command structure
+ * @param bcmd berkey DB command structure
+ * @return 0 on success, -1 on error
+ */
 int bdb_prepare_query(db_cmd_t *cmd, bdb_cmd_t *bcmd)
 {
 	bdb_tcache_t *tbc = NULL;
@@ -189,6 +194,12 @@ int bdb_prepare_query(db_cmd_t *cmd, bdb_cmd_t *bcmd)
 	return -1;
 }
 
+/**
+ * Execute a query
+ * @param cmd DB command structure
+ * @param bcmd Berkely DB command structure
+ * @return 0 on success, -1 on error
+ */
 int bdb_query(db_cmd_t *cmd, bdb_cmd_t *bcmd)
 {
 	DBT key;
diff --git a/src/modules/db_berkeley/bdb_cmd.h b/src/modules/db_berkeley/bdb_cmd.h
index 19705cb7ba..dcf5ca4e45 100644
--- a/src/modules/db_berkeley/bdb_cmd.h
+++ b/src/modules/db_berkeley/bdb_cmd.h
@@ -68,6 +68,7 @@ typedef struct _bdb_cmd
  * structure in cmd parameter.
  * @param cmd A generic db_cmd structure to which the newly created bdb_cmd
  *            structure will be attached.
+ * @return 0 on success, -1 on error
  */
 int bdb_cmd(db_cmd_t *cmd);
 
@@ -78,6 +79,7 @@ int bdb_cmd(db_cmd_t *cmd);
  * ldap.
  * @param res A pointer to (optional) result structure if the command returns
  *            a result.
+ * @param cmd DB command structure
  * @retval 0 if executed successfully
  * @retval A negative number if the database server failed to execute command
  * @retval A positive number if there was an error on client side (SER)