X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7442b5ee7ad7cff7aa817c46e4bc94754d91650e..e18e78a7cc106a75e5228c51edd982436682633d:/docs/doxygen/overviews/refcount.h diff --git a/docs/doxygen/overviews/refcount.h b/docs/doxygen/overviews/refcount.h index be24a53e5e..48a2bf1bb7 100644 --- a/docs/doxygen/overviews/refcount.h +++ b/docs/doxygen/overviews/refcount.h @@ -6,7 +6,7 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// -/*! +/** @page overview_refcount Reference Counting @@ -53,7 +53,7 @@ provide comparison operators. Also note that if you only need to do a @c shallow comparison between two wxObject derived classes, you should not use the == and != operators but -rather the wxObject::IsSameAs function. +rather the wxObject::IsSameAs() function. @section overview_refcount_destruct Object Destruction @@ -90,6 +90,11 @@ operators and copy constructors since they are reference-counted: Note that the list above reports the objects which are reference counted in all ports of wxWidgets; some ports may use this technique also for other classes. +All the objects implement a function IsOk() to test if they are referencing valid +data; when the objects are in uninitialized state, you can only use the IsOk() getter; +trying to call any other getter, e.g. wxBrush::GetStyle() on the ::wxNullBrush object, +will result in an assert failure in debug builds. + @section overview_refcount_object Making Your Own Reference Counted Class