Tweak header documentation

This commit is contained in:
2024-05-30 10:41:57 -07:00
parent 5b6e610d54
commit 7a7eef2b7d

View File

@@ -86,14 +86,14 @@ struct __attribute__((__visibility__("default"))) VersionedMap {
/** The version of the most recent call to `setOldestVersion`. */
int64_t getOldestVersion() const;
/** Iterates through a canonicalized view of all the mutations
* from `oldestVersion` to the iterator's version. There may be mutations from
* versions < `oldestVersion`, but they won't affect the result, and can be
* ignored if desired. It's thread-safe to operate on an iterator concurrently
* with any method of `VersionedMap`, as long as it's not invalidated by
* `setOldestVersion`.
* @warning must not outlive its `VersionedMap`.
*/
/** Iterates through a canonicalized view of at least all the mutations from
* `oldestVersion` to the iterator's version. There may be mutations from
* versions < `oldestVersion`, but they won't affect the result of combining
* with `oldestVersion`. It's thread-safe to operate on an iterator
* concurrently with any method of `VersionedMap`, as long as it's not
* invalidated by `setOldestVersion`.
*
* @warning must not outlive its `VersionedMap`. */
struct Iterator {
Iterator() = default;
@@ -156,9 +156,9 @@ struct __attribute__((__visibility__("default"))) VersionedMap {
void firstGeq(const Key *key, const int64_t *version, Iterator *iterator,
int count) const;
/** Returns an iterator to the first mutation visible at `version`, or `end()`
* if none exists. Thread-safe as long as `version` is not concurrently
* invalidated by `setOldestVersion`. */
/** Returns an iterator to the first mutation visible in the view at
* `version`, or `end()` if none exists. Thread-safe as long as `version` is
* not concurrently invalidated by `setOldestVersion`. */
Iterator begin(int64_t version) const;
/** The "past-the-end" iterator. */