Fix incorrect documentation comments on HashSet/Dictionary item removal

This commit is contained in:
Wojtek Figat
2025-07-27 11:07:58 +02:00
parent 2af266727f
commit 8c51ea511a
2 changed files with 4 additions and 4 deletions

View File

@@ -558,7 +558,7 @@ public:
/// Removes element with a specified key. /// Removes element with a specified key.
/// </summary> /// </summary>
/// <param name="key">The element key to remove.</param> /// <param name="key">The element key to remove.</param>
/// <returns>True if cannot remove item from the collection because cannot find it, otherwise false.</returns> /// <returns>True if item was removed from collection, otherwise false.</returns>
template<typename KeyComparableType> template<typename KeyComparableType>
bool Remove(const KeyComparableType& key) bool Remove(const KeyComparableType& key)
{ {
@@ -578,7 +578,7 @@ public:
/// Removes element at specified iterator. /// Removes element at specified iterator.
/// </summary> /// </summary>
/// <param name="i">The element iterator to remove.</param> /// <param name="i">The element iterator to remove.</param>
/// <returns>True if cannot remove item from the collection because cannot find it, otherwise false.</returns> /// <returns>True if item was removed from collection, otherwise false.</returns>
bool Remove(const Iterator& i) bool Remove(const Iterator& i)
{ {
ASSERT(i._collection == this); ASSERT(i._collection == this);

View File

@@ -451,7 +451,7 @@ public:
/// Removes the specified element from the collection. /// Removes the specified element from the collection.
/// </summary> /// </summary>
/// <param name="item">The element to remove.</param> /// <param name="item">The element to remove.</param>
/// <returns>True if cannot remove item from the collection because cannot find it, otherwise false.</returns> /// <returns>True if item was removed from collection, otherwise false.</returns>
template<typename ItemType> template<typename ItemType>
bool Remove(const ItemType& item) bool Remove(const ItemType& item)
{ {
@@ -471,7 +471,7 @@ public:
/// Removes an element at specified iterator position. /// Removes an element at specified iterator position.
/// </summary> /// </summary>
/// <param name="i">The element iterator to remove.</param> /// <param name="i">The element iterator to remove.</param>
/// <returns>True if cannot remove item from the collection because cannot find it, otherwise false.</returns> /// <returns>True if item was removed from collection, otherwise false.</returns>
bool Remove(const Iterator& i) bool Remove(const Iterator& i)
{ {
ASSERT(i._collection == this); ASSERT(i._collection == this);