Document operator* result lifetime

This commit is contained in:
2024-05-01 12:42:48 -07:00
parent a14f208c39
commit 8831498bfb

View File

@@ -90,7 +90,8 @@ struct VersionedMap {
Iterator(Iterator &&) noexcept; Iterator(Iterator &&) noexcept;
Iterator &operator=(Iterator &&) noexcept; Iterator &operator=(Iterator &&) noexcept;
/** iter must not be `end()` */ /** iter must not be `end()`. Memory pointed-to by return value is valid as
* long as the iterator is valid. */
Mutation operator*() const; Mutation operator*() const;
/** iter must not be `end()` */ /** iter must not be `end()` */