From 8831498bfb690c01aebc472df15a283351596aa4 Mon Sep 17 00:00:00 2001 From: Andrew Noyes Date: Wed, 1 May 2024 12:42:48 -0700 Subject: [PATCH] Document operator* result lifetime --- include/VersionedMap.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/VersionedMap.h b/include/VersionedMap.h index cadd306..6ad28fd 100644 --- a/include/VersionedMap.h +++ b/include/VersionedMap.h @@ -90,7 +90,8 @@ struct VersionedMap { Iterator(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; /** iter must not be `end()` */