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

xo-alloc: doc improvements

Browse source
This commit is contained in:
Roland Conybeare 2025-11-15 12:25:03 -05:00
commit 954921c641
5 changed files with 52 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

16
include/xo/alloc/Forwarding1.hpp
View file

@ -7,6 +7,16 @@
namespace xo {
namespace obj {
/** @class Forwarding1
* @brief forwarding pointer for garbage collector.
*
* Used internally by garbage collector (see @ref GC).
* During evacuate phase overwrite from-space objects in-place
* with an instance of this class.
*
* This class suitable only for singly-inheriting objects,
* i.e. those that have exactly one vtable.
**/
class Forwarding1 : public Object {
public:
explicit Forwarding1(gp<Object> dest);
@ -17,11 +27,11 @@ namespace xo {
virtual bool _is_forwarded() const final override { return true; }
virtual Object * _offset_destination(Object * src) const final override;
virtual Object * _destination() final override;
/** never called on Forwarding1 **/
/** required by Object i/face, but never called on Forwarding1 **/
virtual std::size_t _shallow_size() const final override;
/** never called on Forwarding1 **/
/** required by Object i/face, but never called on Forwarding1 **/
virtual Object * _shallow_copy() const final override;
/** never called on Forwarding1 **/
/** required by Object i/face, but never called on Forwarding1 **/
virtual std::size_t _forward_children() final override;
private: