Some documentation corrections.

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@26115 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
rfm 2008-02-21 15:12:28 +00:00
parent 9c1da2872f
commit b3417764f6
5 changed files with 37 additions and 19 deletions

View file

@ -1,3 +1,11 @@
2008-02-21 Richard Frith-Macdonald <rfm@gnu.org>
* Headers/Foundation/NSKeyValueCoding.h:
* Headers/Foundation/NSThread.h:
* Headers/Foundation/NSKeyValueObserving.h:
* Headers/Additions/GNUstepBase/GSXML.h:
Documentation fixes.
2008-02-20 Richard Frith-Macdonald <rfm@gnu.org>
* Source/Additiuons/GSObjCRuntime.m: Add support for NSPoint, NSRange,

View file

@ -648,7 +648,7 @@ extern "C" {
* Raises an exception if parsing fails.<br />
* Used internally when making a method call to a remote server.
*/
- (NSDictionary*) parseResponse: (NSData*)response
- (NSDictionary*) parseResponse: (NSData*)resp
params: (NSMutableArray*)params;
/**

View file

@ -94,21 +94,26 @@ GS_EXPORT NSString* const NSUndefinedKeyException;
/**
* Returns a mutable array value for a given key. This method:
* <orderedlist>
* <list>
* <item>Searches the receiver for methods matching the patterns
* insertObject:in<Key>AtIndex: and removeObjectFrom<Key>AtIndex:. If both
* insertObject:in&lt;Key&gt;AtIndex: and
* removeObjectFrom&lt;Key&gt;AtIndex:. If both
* methods are found, each message sent to the proxy array will result in the
* invocation of one or more of these methods. If
* replaceObjectIn<Key>AtIndex:withObject: is also found in the receiver it
* replaceObjectIn&lt;Key&gt;AtIndex:withObject:
* is also found in the receiver it
* will be used when appropriate for better performance.</item>
* <item>If the set of methods is not found, searches the receiver for a the
* method set<Key>:. Each message sent to the proxy array will result in
* the invocation of set<Key>:</item>
* method set&lt;Key&gt;:. Each message sent to the proxy array will result in
* the invocation of set&lt;Key&gt;:</item>
* <item>If the previous do not match, and accessInstanceVariablesDirectly
* returns YES, searches for an instance variable matching _<key> or
* <key> (in that order). If the instance variable is found, messages sent
* returns YES, searches for an instance variable matching _&lt;key&gt; or
* &lt;key&gt; (in that order). If the instance variable is found,
* messages sent
* to the proxy object will be forwarded to the instance variable.</item>
* <item>If none of the previous are found, raises an NSUndefinedKeyException
* </item>
* </list>
*/
- (NSMutableArray*) mutableArrayValueForKey: (NSString*)aKey;
@ -119,23 +124,28 @@ GS_EXPORT NSString* const NSUndefinedKeyException;
/**
* Returns a mutable set value for a given key. This method:
* <orderedlist>
* <list>
* <item>Searches the receiver for methods matching the patterns
* add<Key>Object:, remove<Key>Object:, add<Key>:, and remove<Key>:, which
* add&lt;Key&gt;Object:, remove&lt;Key&gt;Object:,
* add&lt;Key&gt;:, and remove&lt;Key&gt;:, which
* correspond to the NSMutableSet methods addObject:, removeObject:,
* unionSet:, and minusSet:, respectively. If at least one addition
* and one removal method are found, each message sent to the proxy set
* will result in the invocation of one or more of these methods. If
* intersect<Key>: or set<Key>: is also found in the receiver, the method(s)
* intersect&lt;Key&gt;: or set&lt;Key&gt;:
* is also found in the receiver, the method(s)
* will be used when appropriate for better performance.</item>
* <item>If the set of methods is not found, searches the receiver for a the
* method set<Key>:. Each message sent to the proxy set will result in
* the invocation of set<Key>:</item>
* method set&lt;Key&gt;:. Each message sent to the proxy set will result in
* the invocation of set&lt;Key&gt;:</item>
* <item>If the previous do not match, and accessInstanceVariablesDirectly
* returns YES, searches for an instance variable matching _<key> or
* <key> (in that order). If the instance variable is found, messages sent
* returns YES, searches for an instance variable matching _&lt;key&gt; or
* &lt;key&gt; (in that order). If the instance variable is found,
* messages sent
* to the proxy object will be forwarded to the instance variable.</item>
* <item>If none of the previous are found, raises an NSUndefinedKeyException
* </item>
* </list>
*/
- (NSMutableSet*) mutableSetValueForKey: (NSString *)aKey;

View file

@ -203,10 +203,10 @@ GS_EXPORT NSString *const NSKeyValueChangeOldKey;
/**
* Tells the observing system that when NSKeyValueObserverNotification
* protocol messages are sent for any key in the keys array, they should
* also be sent for dependentKey.
* protocol messages are sent for any key in the triggerKeys array,
* they should also be sent for dependentKey.
*/
+ (void) setKeys: (NSArray*)keys
+ (void) setKeys: (NSArray*)triggerKeys
triggerChangeNotificationsForDependentKey: (NSString*)dependentKey;
/**

View file

@ -88,7 +88,7 @@ extern "C" {
*/
- (void) cancel;
/** </init>
/** <init/>
*/
- (id) init;