src/core/object.h
changeset 3190 51fe9001a679
parent 3182 61fe7fe81ebd
child 3394 1680d5004ee8
     1.1 --- a/src/core/object.h	Thu May 29 23:24:10 2008 -0700
     1.2 +++ b/src/core/object.h	Mon Jun 02 10:30:24 2008 -0700
     1.3 @@ -46,6 +46,14 @@
     1.4   * \ingroup object
     1.5   * \brief a base class which provides memory management and object aggregation
     1.6   *
     1.7 + * The memory management scheme is based on reference-counting with dispose-like
     1.8 + * functionality to break the reference cycles. The reference count is increamented
     1.9 + * and decremented with the methods Object::Ref and Object::Unref. If a reference cycle is
    1.10 + * present, the user is responsible for breaking it by calling Object::Dispose in
    1.11 + * a single location. This will eventually trigger the invocation of Object::DoDispose 
    1.12 + * on itself and all its aggregates. The Object::DoDispose method is always automatically
    1.13 + * invoked from the Object::Unref method before destroying the object, even if the user 
    1.14 + * did not call Object::Dispose directly.
    1.15   */
    1.16  class Object : public ObjectBase
    1.17  {