From 5bd896b1530647fac14b1916891b470d2e2ae8c1 Mon Sep 17 00:00:00 2001 From: Chris Cromer Date: Sat, 19 Jan 2019 14:10:37 -0300 Subject: [PATCH] fix some valadoc --- lib/db/asociado.vala | 2 ++ lib/db/tour.vala | 10 +++++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/lib/db/asociado.vala b/lib/db/asociado.vala index cd00567..6c08453 100644 --- a/lib/db/asociado.vala +++ b/lib/db/asociado.vala @@ -127,6 +127,8 @@ JOIN region R2 ON (C2.id_region = R2.id_region) * Get all tuples and fields from database * @param conn The database connection to use * @return Returns a list of Asociado based off a tour id + * @throws PostgresError Thrown if there is a problem with escaping strings + * @throws DBError Thrown if an invalid value is passed */ public static List get_all_asociados_by_tour (Connection conn, Tour tour) throws PostgresError, DBError { if (tour.id_tour == 0) { diff --git a/lib/db/tour.vala b/lib/db/tour.vala index 1578b7b..2966857 100644 --- a/lib/db/tour.vala +++ b/lib/db/tour.vala @@ -68,6 +68,7 @@ namespace LibSernatur { * Get all tuples and fields from database * @param conn The database connection to use * @return Returns a list of Tour + * @throws PostgresError If there is a problem with with escaping strings */ public static List get_all_tours (Connection conn) throws PostgresError { var res = conn.db.exec (Query.get_query (conn, Query.Type.SELECT_ALL_TOURS, null)); @@ -114,7 +115,8 @@ namespace LibSernatur { * Update a tour in the database * @param conn The database connection * @param tour The tour to update - * @throws DBError Thrown if the data in the object is invalid + * @throws PostgresError Thrown if there is a problem with escaping strings + * @throws DBError Thrown if an invalid value is passed */ public static void update_tour (Connection conn, Tour tour) throws PostgresError, DBError { if (tour.id_tour == 0) { @@ -135,7 +137,8 @@ namespace LibSernatur { * @param conn The database connection * @param tour The tour to insert * @return Returns the id of the tuple inserted - * @throws DBError Thrown if the data in the object is invalid + * @throws PostgresError Thrown if there is a problem with escaping strings + * @throws DBError Thrown if an invalid value is passed */ public static uint insert_tour (Connection conn, Tour tour) throws PostgresError, DBError { if (tour.id_tour != 0) { @@ -169,7 +172,8 @@ namespace LibSernatur { * Delete a tour in the database * @param conn The database connection * @param tour The tour to update - * @throws DBError Thrown if the data in the object is invalid + * @throws PostgresError Thrown if there is a problem with escaping strings + * @throws DBError Thrown if an invalid value is passed */ public static void delete_tour (Connection conn, Tour tour) throws PostgresError, DBError { if (tour.id_tour == 0) {