mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-22 08:26:27 +00:00
Minor documentation tweaks.
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@18938 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
CaS
parent
1df7325dc3
commit
e845237c55
7 changed files with 59 additions and 44 deletions
|
|
@ -1,8 +1,13 @@
|
|||
2004-03-27 Richard Frith-Macdonald <rfm@gnu.org>
|
||||
|
||||
* NSMessagePort.m:
|
||||
* NSMessagePortNameServer.m: Use base library methods for file
|
||||
* Source/NSMessagePort.m:
|
||||
* Source/NSMessagePortNameServer.m: Use base library methods for file
|
||||
management rather than unix syscalls.
|
||||
* Headers/Foundation/NSRunLoop.h:
|
||||
* Source/NSRunLoop.m:
|
||||
* Source/NSString.m:
|
||||
* Source/NSTimeZone.m:
|
||||
Various minor documentation tweaks.
|
||||
|
||||
2004-03-27 Alexander Malmberg <alexander@malmberg.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -368,10 +368,10 @@
|
|||
params: (NSDictionary*)params;
|
||||
|
||||
+ (GSXMLDocument*) xsltTransformXml: (NSData*)xmlData
|
||||
stylesheet: (NSData*)xsltSylesheet;
|
||||
stylesheet: (NSData*)xsltStylesheet;
|
||||
|
||||
- (GSXMLDocument*) xsltTransform: (GSXMLDocument*)xsltStylesheet
|
||||
params: (NSDictionary*)parameters;
|
||||
params: (NSDictionary*)params;
|
||||
|
||||
- (GSXMLDocument*) xsltTransform: (GSXMLDocument*)xsltStylesheet;
|
||||
@end
|
||||
|
|
|
|||
|
|
@ -97,23 +97,28 @@ typedef enum {
|
|||
ET_EDESC /* Watch for descriptor with out-of-band data. */
|
||||
} RunLoopEventType;
|
||||
|
||||
/**
|
||||
* This protocol documents the callback messages that an object
|
||||
* receives if it has registered to receive run loop events using
|
||||
* [NSRunLoop-addEvent:type:watcher:forMode:]
|
||||
*/
|
||||
@protocol RunLoopEvents
|
||||
/*
|
||||
* Callback message sent to object waiting for an event in the
|
||||
* runloop when the limit-date for the operation is reached.
|
||||
* If an NSDate object is returned, the operation is restarted
|
||||
* with the new limit-date, otherwise it is removed from the
|
||||
* run loop.
|
||||
/**
|
||||
* Callback message sent to object waiting for an event in the
|
||||
* runloop when the limit-date for the operation is reached.
|
||||
* If an NSDate object is returned, the operation is restarted
|
||||
* with the new limit-date, otherwise it is removed from the
|
||||
* run loop.
|
||||
*/
|
||||
- (NSDate*) timedOutEvent: (void*)data
|
||||
type: (RunLoopEventType)type
|
||||
forMode: (NSString*)mode;
|
||||
/*
|
||||
* Callback message sent to object when the event it it waiting
|
||||
* for occurs. The 'data' and 'type' valueds are those passed in the
|
||||
* original addEvent:type:watcher:forMode: method.
|
||||
* The 'extra' value may be additional data returned depending
|
||||
* on the type of event.
|
||||
/**
|
||||
* Callback message sent to object when the event it it waiting
|
||||
* for occurs. The 'data' and 'type' valueds are those passed in the
|
||||
* original addEvent:type:watcher:forMode: method.
|
||||
* The 'extra' value may be additional data returned depending
|
||||
* on the type of event.
|
||||
*/
|
||||
- (void) receivedEvent: (void*)data
|
||||
type: (RunLoopEventType)type
|
||||
|
|
@ -121,22 +126,39 @@ typedef enum {
|
|||
forMode: (NSString*)mode;
|
||||
@end
|
||||
|
||||
/**
|
||||
* These are general purpose methods for letting objects ask
|
||||
* the runloop to watch for events for them. Only one object
|
||||
* at a time may be watching for a particular event in a mode, but
|
||||
* that object may add itsself as a watcher many times as long as
|
||||
* each addition is matched by a removal (the run loop keeps count).
|
||||
* Alternatively, the 'removeAll' parameter may be set to 'YES' for
|
||||
* [-removeEvent:type:forMode:all:] in order to remove the watcher
|
||||
* irrespective of the number of times it has been added.
|
||||
*/
|
||||
@interface NSRunLoop(GNUstepExtensions)
|
||||
|
||||
/*
|
||||
* These are general purpose methods for letting objects ask
|
||||
* the runloop to watch for events for them. Only one object
|
||||
* at a time may be watching for a particular event in a mode, but
|
||||
* that object may add itsself as a watcher many times as long as
|
||||
* each addition is matched by a removal (the run loop keeps count).
|
||||
* Alternatively, the 'removeAll' parameter may be set to 'YES' for
|
||||
* [-removeEvent:type:forMode:all:] in order to remove the watcher
|
||||
* irrespective of the number of times it has been added.
|
||||
/**
|
||||
* Adds a runloop watcher matching the specified data and type in this
|
||||
* runloop. If the mode is nil, either the -currentMode is used (if the
|
||||
* loop is running) or NSDefaultRunLoopMode is used.<br />
|
||||
* NB. The watcher is <em>not</em> retained by the run loop and must
|
||||
* be removed from the loop before deallocation ... otherwise the loop
|
||||
* might try to send a message to the deallocated watcher object
|
||||
* resulting in a crash. You use -removeEvent:type:forMode:all: to do this.
|
||||
*/
|
||||
- (void) addEvent: (void*)data
|
||||
type: (RunLoopEventType)type
|
||||
watcher: (id<RunLoopEvents>)watcher
|
||||
forMode: (NSString*)mode;
|
||||
|
||||
/**
|
||||
* Removes a runloop watcher matching the specified data and type in this
|
||||
* runloop. If the mode is nil, either the -currentMode is used (if the
|
||||
* loop is running) or NSDefaultRunLoopMode is used.<br />
|
||||
* The additional removeAll flag may be used to remove all instances of
|
||||
* the watcher rather than just a single one.
|
||||
*/
|
||||
- (void) removeEvent: (void*)data
|
||||
type: (RunLoopEventType)type
|
||||
forMode: (NSString*)mode
|
||||
|
|
|
|||
|
|
@ -3949,7 +3949,7 @@ static BOOL warned = NO; if (warned == NO) { warned = YES; NSLog(@"WARNING, use
|
|||
|
||||
/**
|
||||
* Performs an XSLT transformation on the current document using the
|
||||
* supplied stylesheet and paramaters (parameters may be nil).
|
||||
* supplied stylesheet and paramaters (params may be nil).
|
||||
* See the libxslt documentation for details of the supported parameters.<br />
|
||||
*
|
||||
* Returns an autoreleased GSXMLDocument containing the transformed
|
||||
|
|
@ -4046,7 +4046,7 @@ static BOOL warned = NO; if (warned == NO) { warned = YES; NSLog(@"WARNING, use
|
|||
}
|
||||
|
||||
- (GSXMLDocument*) xsltTransform: (GSXMLDocument*)xsltStylesheet
|
||||
params: (NSDictionary*)parameters
|
||||
params: (NSDictionary*)params
|
||||
{
|
||||
NSLog(@"libxslt is not available");
|
||||
return nil;
|
||||
|
|
|
|||
|
|
@ -1506,11 +1506,6 @@ static void setPollfd(int fd, int event, GSRunLoopCtxt *ctxt)
|
|||
|
||||
@implementation NSRunLoop(GNUstepExtensions)
|
||||
|
||||
/**
|
||||
* Adds a runloop watcher matching the specified data and type in this
|
||||
* runloop. If the mode is nil, either the currentMode is used (if the
|
||||
* loop is running) or NSDefaultRunLoopMode is used.
|
||||
*/
|
||||
- (void) addEvent: (void*)data
|
||||
type: (RunLoopEventType)type
|
||||
watcher: (id<RunLoopEvents>)watcher
|
||||
|
|
@ -1549,13 +1544,6 @@ static void setPollfd(int fd, int event, GSRunLoopCtxt *ctxt)
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a runloop watcher matching the specified data and type in this
|
||||
* runloop. If the mode is nil, either the currentMode is used (if the
|
||||
* loop is running) or NSDefaultRunLoopMode is used.
|
||||
* The additional removeAll flag may be used to remove all instances of
|
||||
* the watcher rather than just a single one.
|
||||
*/
|
||||
- (void) removeEvent: (void*)data
|
||||
type: (RunLoopEventType)type
|
||||
forMode: (NSString*)mode
|
||||
|
|
|
|||
|
|
@ -576,7 +576,7 @@ handle_printf_atsign (FILE *stream,
|
|||
* is released and nil is returned.
|
||||
*/
|
||||
- (id) initWithBytes: (const void*)bytes
|
||||
length: (unsigned)length
|
||||
length: (unsigned int)length
|
||||
encoding: (NSStringEncoding)encoding
|
||||
{
|
||||
if (length == 0)
|
||||
|
|
@ -734,7 +734,7 @@ handle_printf_atsign (FILE *stream,
|
|||
* is released and nil is returned.
|
||||
*/
|
||||
- (id) initWithBytesNoCopy: (const void*)bytes
|
||||
length: (unsigned)length
|
||||
length: (unsigned int)length
|
||||
encoding: (NSStringEncoding)encoding
|
||||
freeWhenDone: (BOOL)flag
|
||||
{
|
||||
|
|
|
|||
|
|
@ -903,7 +903,7 @@ static NSMapTable *absolutes = 0;
|
|||
* 2) the GNUSTEP_TZ environment variable<br/ >
|
||||
* 3) the file "localtime" in System/Library/Libraries/Resources/NSTimeZone<br/ >
|
||||
* 4) the TZ environment variable<br/ >
|
||||
* 5) tzset() and tznam on platforms which have it<br/ >
|
||||
* 5) tzset and tznam on platforms which have it<br/ >
|
||||
* 6) Windows registry, on Win32 systems<br/ >
|
||||
* 7) or the fallback time zone (which is UTC)<br/ >
|
||||
* with the ones listed first having precedence.
|
||||
|
|
@ -1368,11 +1368,11 @@ static NSMapTable *absolutes = 0;
|
|||
* Returns a timezone for aTimeZoneName, created from the supplied
|
||||
* time zone data. Data must be in TZ format as per the Olson database.
|
||||
*/
|
||||
+ (NSTimeZone*) timeZoneWithName: (NSString*)aTimeZoneName data: (NSData*)data
|
||||
+ (NSTimeZone*) timeZoneWithName: (NSString*)name data: (NSData*)data
|
||||
{
|
||||
NSTimeZone *zone;
|
||||
|
||||
zone = [defaultPlaceholderTimeZone initWithName: aTimeZoneName data: data];
|
||||
zone = [defaultPlaceholderTimeZone initWithName: name data: data];
|
||||
return AUTORELEASE(zone);
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue