From fa6f34e40341adf551e0c48006249d381594fc1d Mon Sep 17 00:00:00 2001 From: CaS Date: Tue, 13 Nov 2001 17:37:13 +0000 Subject: [PATCH] Document deallocation notifications git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@11402 72102866-910b-0410-8b05-ffd578937521 --- Documentation/gsdoc/NSObject.gsdoc | 50 ++++++++++++++++++++++ Documentation/gsdoc/NSObject.html | 66 ++++++++++++++++++++++++++++++ 2 files changed, 116 insertions(+) diff --git a/Documentation/gsdoc/NSObject.gsdoc b/Documentation/gsdoc/NSObject.gsdoc index 40fa7d397..3426956f2 100644 --- a/Documentation/gsdoc/NSObject.gsdoc +++ b/Documentation/gsdoc/NSObject.gsdoc @@ -568,6 +568,56 @@ + + deallocNotificationsActive + +

+ Returns a boolean indicating whether deallocation notification + has been turned on. +

+

+ If deallocation notification is turned on, whenever an objects + retain count reaches zero (and it would normally be deallocated) + the _dealloc methiod is called and the object is only + deallocated if that method returns YES. +

+ + + + setDeallocNotificationsActive: + flag + +

+ Turns on (or off) deallocation notification. +

+

+ If deallocation notification is turned on, whenever an objects + retain count reaches zero (and it would normally be deallocated) + the _dealloc methiod is called and the object is only + deallocated if that method returns YES. +

+ + + + _dealloc + +

+ Returns a boolean indicating whether the receiver should be + deallocated or not. The default implementation returns YES. +

+

+ This method is called when an objects retain count reaches + zero (if deallocation notifications are active). +

+

+ This method is provided so that you can take some sort of + action when objects are deallocated ... normally you would + override this method in your classes, but you could also + override it in a category of NSObject - and perform some + action whenever any object is deallocated. +

+ + diff --git a/Documentation/gsdoc/NSObject.html b/Documentation/gsdoc/NSObject.html index 0034d3133..06967d224 100644 --- a/Documentation/gsdoc/NSObject.html +++ b/Documentation/gsdoc/NSObject.html @@ -116,6 +116,7 @@
  • +setVersion:
  • +superclass
  • +version +
  • -_dealloc
  • -awakeAfterUsingCoder:
  • -classForArchiver
  • -classForCoder @@ -123,6 +124,7 @@
  • -connection:handleRequest:
  • -copy
  • -dealloc +
  • -deallocNotificationsActive
  • -description
  • -descriptionWithLocale:
  • -descriptionWithLocale:indent: @@ -140,6 +142,7 @@
  • -replacementObjectForArchiver:
  • -replacementObjectForCoder:
  • -replacementObjectForPortCoder: +
  • -setDeallocNotificationsActive:

    Class Methods

    alloc

    @@ -625,6 +628,69 @@ Standards: GNUstep
    - (id) replacementObjectForPortCoder: (NSPortCoder*)aCoder;
    +
    +

    deallocNotificationsActive

    +- (BOOL) deallocNotificationsActive;
    + +

    + + Returns a boolean indicating whether deallocation notification + has been turned on. +

    + +

    + + If deallocation notification is turned on, whenever an objects + retain count reaches zero (and it would normally be deallocated) + the _dealloc methiod is called and the object is only + deallocated if that method returns YES. +

    + + +
    +

    setDeallocNotificationsActive:

    +- (void) setDeallocNotificationsActive: (BOOL)flag;
    + +

    + + Turns on (or off) deallocation notification. +

    + +

    + + If deallocation notification is turned on, whenever an objects + retain count reaches zero (and it would normally be deallocated) + the _dealloc methiod is called and the object is only + deallocated if that method returns YES. +

    + + +
    +

    _dealloc

    +- (BOOL) _dealloc;
    + +

    + + Returns a boolean indicating whether the receiver should be + deallocated or not. The default implementation returns YES. +

    + +

    + + This method is called when an objects retain count reaches + zero (if deallocation notifications are active). +

    + +

    + + This method is provided so that you can take some sort of + action when objects are deallocated ... normally you would + override this method in your classes, but you could also + override it in a category of NSObject - and perform some + action whenever any object is deallocated. +

    + +