NFC: ds/pagemap: tweak commentary

This commit is contained in:
Nathaniel Wesley Filardo 2022-12-10 10:53:56 +00:00 коммит произвёл Nathaniel Filardo
Родитель a42c4303e0
Коммит 48340faa09
1 изменённых файлов: 11 добавлений и 6 удалений

Просмотреть файл

@ -250,10 +250,13 @@ namespace snmalloc
}
/**
*
* Get a non-constant reference to the slot of this pagemap corresponding
* to a particular address.
*
* If the location has not been used before, then
* `potentially_out_of_range` should be set to true.
* This will ensure there is a location for the
* read/write.
* `potentially_out_of_range` should be set to true. This will ensure
* there is memory backing the returned reference.
*/
template<bool potentially_out_of_range>
T& get_mut(address_t p)
@ -301,10 +304,12 @@ namespace snmalloc
}
/**
* Get a constant reference to the slot of this pagemap corresponding to a
* particular address.
*
* If the location has not been used before, then
* `potentially_out_of_range` should be set to true.
* This will ensure there is a location for the
* read/write.
* `potentially_out_of_range` should be set to true. This will ensure
* there is memory backing any reads through the returned reference.
*/
template<bool potentially_out_of_range>
const T& get(address_t p)