roland/xo-gc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

xo-gc: doc: + comment on GCObjectVisitor entry points

Browse source
This commit is contained in:
Roland Conybeare 2026-04-12 15:38:42 -04:00
commit 46ce36d0f5
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/xo/gc/detail/IGCObjectVisitor_DGCObjectStoreVisitor.hpp
View file

@ -46,10 +46,12 @@ namespace xo {
///@{
// const methods
/** allocation metadata for gc-aware data at address @p gco.
@p gco must be the result of a call to collector's alloc() function **/
@p gco must be the result of a call to collector's alloc() function
note: load-bearing for xo-gc/MutationLogStore **/
static AllocInfo alloc_info(const DGCObjectStoreVisitor & self, void * addr);
/** generation to which pointer @p addr belongs, given role @p r;
sentinel if @p addr is not owned by collector **/
sentinel if @p addr is not owned by collector.
note: load-bearing for xo-gc/MutationLogStore **/
static Generation generation_of(const DGCObjectStoreVisitor & self, Role r, const void * addr) noexcept;
// non-const methods