gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-04-23 00:41:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

Documented GNUstep methods

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@9916 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2001-05-10 19:48:29 +00:00
parent 1f7dc67da9
commit f044fb9d38
1 changed files with 83 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

83
Documentation/gsdoc/NSAutoreleasePool.gsdoc
View file

@ -17,19 +17,102 @@
<declared>Foundation/NSAutoreleasePool.h</declared>
<conform>NSObject</conform>
<desc>
<p>
This class maintains a stack of autorelease pools objects
in each thread.
</p>
<p>
When an autorelease pool is created, it is automatically
added to the stack of pools in the thread.
</p>
<p>
When a pool is destroyed, it (and any pool later in
the stack) is removed from the stack.
</p>
</desc>
<method type="void" factory="yes">
<sel>addObject:</sel>
<arg type="id">anObject</arg>
<desc>
<p>
Adds the specified object to the current autorelease pool.
If there is no autorelease pool in the thread,
a warning is logged.
</p>
</desc>
</method>
<method type="void">
<sel>addObject:</sel>
<arg type="id">anObject</arg>
<desc>
<p>
Adds the specified object to this autorelease pool.
</p>
</desc>
</method>
<method type="void" factory="yes">
<sel>enableRelease:</sel>
<arg type="BOOL">flag</arg>
<desc>
<p>
Specifies whether objects contained in autorelease pools are to
be released when the pools are deallocated (by default YES).
</p>
<p>
You can set this to NO for debugging purposes.
</p>
</desc>
<standards><GNUstep/><NotMacOS-X/><NotOpenStep/></standards>
</method>
<method type="unsigned" factory="yes">
<sel>autoreleaseCountForObject:</sel>
<arg type="id">anObject</arg>
<desc>
<p>
Counts the number of times that the specified object occurs
in autorelease pools in the current thread.
</p>
<p>
This method is <em>slow</em> and should probably only be
used for debugging purposes.
</p>
</desc>
<standards><GNUstep/><NotMacOS-X/><NotOpenStep/></standards>
</method>
<method type="void" factory="yes">
<sel>freeCache</sel>
<desc>
<p>
When autorelease pools are deallocated, the memory they used
is retained in a cache for re-use so that new polls can be
created very quickly.
</p>
<p>
This method may be used to empty that cache, ensuring that
the minimum memory is used by the application.
</p>
</desc>
<standards><GNUstep/><NotMacOS-X/><NotOpenStep/></standards>
</method>
<method type="void" factory="yes">
<sel>setPoolCountThreshold:</sel>
<arg type="unsigned">c</arg>
<desc>
<p>
Specifies a limit to the number of objects that may be added to
an autorelease pool. When this limit is reached an exception is
raised.
</p>
<p>
You can set this to a smallish value to catch problems with code
that autoreleases too many objects to operate efficiently.
</p>
<p>
Default value is maxint.
</p>
</desc>
<standards><GNUstep/><NotMacOS-X/><NotOpenStep/></standards>
</method>
</class>
</chapter>
</body>