gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-04-22 16:33:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added documentation for GNUstep thread extensions

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@9566 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2001-04-12 12:24:50 +00:00
parent 5e7105d2f7
commit 4f1b55e396
2 changed files with 67 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
Documentation/gsdoc/NSFunctions.gsdoc
View file

@ -13,7 +13,65 @@
<body>
<chapter>
<heading>Functions</heading>
<function name="GSCurrentThread" type="NSThread*">
<declared>Foundation/NSThread.h</declared>
<desc>
<p>
This function is a GNUstep extension. It pretty much
duplicates the functionality of [NSThread +currentThread]
but is more efficient and is used internally throughout
GNUstep.
</p>
<p>
Returns the current thread. Could perhaps return <code>nil</code>
if executing a thread that was started outside the GNUstep
environment and not registered (this should not happen in a
well-coded application).
</p>
</desc>
<standards><NotOpenStep/><NotMacOS-X/><GNUstep/></standards>
</function>
<function name="GSRegisterCurrentThread" type="BOOL">
<declared>Foundation/NSThread.h</declared>
<desc>
<p>
This functiion is provided to let threads started by some other
software library register themselves to be used with the
GNUstep system. All such threads should call this function
before attempting to use any GNUstep objects.
</p>
<p>
Returns <code>YES</code> if the thread can be registered,
<code>NO</code> if it is already registered.
</p>
<p>
Sends out a <code>NSWillBecomeMultiThreadedNotification</code>
if the process was not already multithreaded.
</p>
</desc>
<standards><NotOpenStep/><NotMacOS-X/><GNUstep/></standards>
</function>
<function name="GSUnregisterCurrentThread" type="void">
<declared>Foundation/NSThread.h</declared>
<desc>
<p>
This functiion is provided to let threads started by some other
software library unregister themselves from the GNUstep threading
system.
</p>
<p>
Calling this function causes a
<code>NSThreadWillExitNotification</code>
to be sent out, and destroys the GNUstep NSThread object
associated with the thread.
</p>
</desc>
<standards><NotOpenStep/><NotMacOS-X/><GNUstep/></standards>
</function>
</chapter>
<chapter>
<heading>Types</heading>
<type name="NSRange">

9
Documentation/gsdoc/NSThread.gsdoc
View file

@ -21,6 +21,15 @@
<method type="NSThread*" factory="yes">
<sel>currentThread</sel>
<desc>
<p>
Returns the NSThread object corresponding to the current thread.
</p>
<p>
NB. In GNUstep the library internals use the GSCurrentThread()
function as a more efficient mechanism for doing this job - so
you cannot use a category to override this method and expect
the library internals to use your implementation.
</p>
</desc>
</method>
<method type="void" factory="yes">