From b516f2f07f2b27998881a15b8438d83ee8d8ab34 Mon Sep 17 00:00:00 2001 From: Horst Schirmeier Date: Mon, 23 Nov 2020 16:19:10 +0100 Subject: [PATCH] Database: doc fixes Change-Id: I6304e4379ee0d94bd816b968eb5f08a281cfd0b4 --- src/core/util/Database.hpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/core/util/Database.hpp b/src/core/util/Database.hpp index cc2e3bea..75181e25 100644 --- a/src/core/util/Database.hpp +++ b/src/core/util/Database.hpp @@ -78,11 +78,11 @@ namespace fail { */ MYSQL * getHandle() const { return handle; } /** - * Do a small database query. If get_result is set to false - * (MYSQL_RES *)0 or (MYSQL_RES *)1 is given back to indicate - * the result of the query. If the result should be fetched - * a pointer is returned. This pointer is valid until the next - * call to this->query(stmt, true) + * Do a small database query. A return value of (MYSQL_RES *)0 + * indicates a query failure. If get_result is set to false, a return + * value of (MYSQL_RES *)1 indicates success; if get_result is true, a + * MySQL result handle is returned. This handle is valid until the + * next call to this->query(stmt, true) */ MYSQL_RES *query(char const *query, bool get_result = false); /**