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