From 8c51ea511a578b43e163f742ab4dded2a143c92a Mon Sep 17 00:00:00 2001 From: Wojtek Figat Date: Sun, 27 Jul 2025 11:07:58 +0200 Subject: [PATCH] Fix incorrect documentation comments on HashSet/Dictionary item removal --- Source/Engine/Core/Collections/Dictionary.h | 4 ++-- Source/Engine/Core/Collections/HashSet.h | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Source/Engine/Core/Collections/Dictionary.h b/Source/Engine/Core/Collections/Dictionary.h index bdab15bbe..e2f5f0ed6 100644 --- a/Source/Engine/Core/Collections/Dictionary.h +++ b/Source/Engine/Core/Collections/Dictionary.h @@ -558,7 +558,7 @@ public: /// Removes element with a specified key. /// /// The element key to remove. - /// True if cannot remove item from the collection because cannot find it, otherwise false. + /// True if item was removed from collection, otherwise false. template bool Remove(const KeyComparableType& key) { @@ -578,7 +578,7 @@ public: /// Removes element at specified iterator. /// /// The element iterator to remove. - /// True if cannot remove item from the collection because cannot find it, otherwise false. + /// True if item was removed from collection, otherwise false. bool Remove(const Iterator& i) { ASSERT(i._collection == this); diff --git a/Source/Engine/Core/Collections/HashSet.h b/Source/Engine/Core/Collections/HashSet.h index 032a407db..b0fa8d7b5 100644 --- a/Source/Engine/Core/Collections/HashSet.h +++ b/Source/Engine/Core/Collections/HashSet.h @@ -451,7 +451,7 @@ public: /// Removes the specified element from the collection. /// /// The element to remove. - /// True if cannot remove item from the collection because cannot find it, otherwise false. + /// True if item was removed from collection, otherwise false. template bool Remove(const ItemType& item) { @@ -471,7 +471,7 @@ public: /// Removes an element at specified iterator position. /// /// The element iterator to remove. - /// True if cannot remove item from the collection because cannot find it, otherwise false. + /// True if item was removed from collection, otherwise false. bool Remove(const Iterator& i) { ASSERT(i._collection == this);