From 4afa0be5672f01b8ad0747b3846a68bfa91a6c16 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Mon, 23 Aug 2021 09:05:42 +0200
Subject: [PATCH] DOC: Made the documentation for WaitForIt() more explicit.
---
include/caosdb/transaction.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/include/caosdb/transaction.h b/include/caosdb/transaction.h
index 78524cf..0fb724a 100644
--- a/include/caosdb/transaction.h
+++ b/include/caosdb/transaction.h
@@ -345,7 +345,8 @@ public:
*
* A client may request the current status at any time via GetStatus().
*
- * Use WaitForIt() to join the back-ground execution of this transaction.
+ * Use WaitForIt() to join the back-ground execution of this transaction, otherwise the behaviour
+ * of getting the ResultSet is undefined.
*/
auto ExecuteAsynchronously() noexcept -> StatusCode;
@@ -353,7 +354,8 @@ public:
* Join the background execution and return the status when the execution
* terminates.
*
- * Use this after ExecuteAsynchronously().
+ * Use this after ExecuteAsynchronously(), otherwise the TransactionStatus still remains
+ * EXECUTING.
*/
[[nodiscard]] auto WaitForIt() const noexcept -> TransactionStatus;
--
GitLab