From 0daf3b36cf46a80d2a68300439210ae3bca55428 Mon Sep 17 00:00:00 2001
From: scott snyder <scott.snyder@cern.ch>
Date: Tue, 11 Dec 2018 09:37:25 +0100
Subject: [PATCH] CxxUtils: Update documentation.
Fix an outdated comment in ConcurrentRangeMap.
Former-commit-id: 4c49be3c7cd4a0ae6028c45ff71191e39780b6a7
---
Control/CxxUtils/CxxUtils/ConcurrentRangeMap.h | 6 ++++--
Control/CxxUtils/CxxUtils/ConcurrentRangeMap.icc | 6 ++++--
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/Control/CxxUtils/CxxUtils/ConcurrentRangeMap.h b/Control/CxxUtils/CxxUtils/ConcurrentRangeMap.h
index 03c384690ff..01bec029f01 100644
--- a/Control/CxxUtils/CxxUtils/ConcurrentRangeMap.h
+++ b/Control/CxxUtils/CxxUtils/ConcurrentRangeMap.h
@@ -313,9 +313,11 @@ public:
* @param ptr Payload for this element.
* @param ctx Execution context.
*
- * Returns true if the new element was successfully inserted.
- * Returns false if the range compared equal to an existing one. In that case,
+ * Returns SUCCESS if the new element was successfully inserted.
+ * Returns DUPLICATE if the range compared equal to an existing one. In that case,
* no new element is inserted (and @c ptr gets deleted).
+ * Returns OVERLAP if the range of the new element overlaps
+ * an existing element (the new element is still inserted).
*/
EmplaceResult emplace (const RANGE& range,
payload_unique_ptr ptr,
diff --git a/Control/CxxUtils/CxxUtils/ConcurrentRangeMap.icc b/Control/CxxUtils/CxxUtils/ConcurrentRangeMap.icc
index c88dd789cc2..d9e999ebd10 100644
--- a/Control/CxxUtils/CxxUtils/ConcurrentRangeMap.icc
+++ b/Control/CxxUtils/CxxUtils/ConcurrentRangeMap.icc
@@ -165,9 +165,11 @@ CONCURRENTRANGEMAP::find (const key_query_type& key) const
* @param ptr Payload for this element.
* @param ctx Execution context.
*
- * Returns true if the new element was successfully inserted.
- * Returns false if the range compared equal to an existing one. In that case,
+ * Returns SUCCESS if the new element was successfully inserted.
+ * Returns DUPLICATE if the range compared equal to an existing one. In that case,
* no new element is inserted (and @c ptr gets deleted).
+ * Returns OVERLAP if the range of the new element overlaps
+ * an existing element (the new element is still inserted).
*/
T_CONCURRENTRANGEMAP
typename CONCURRENTRANGEMAP::EmplaceResult
--
GitLab