mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-23 00:41:02 +00:00
Some documentation updates
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/branches/freeze-1_0_0@9494 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald
parent
be2f7d723a
commit
d87f3d3eed
6 changed files with 132 additions and 3 deletions
|
|
@ -174,7 +174,7 @@
|
|||
<li><a href ="NSUserDefaults.html">NSUserDefaults</a>
|
||||
<li><a href ="NSValue.html">NSValue</a>
|
||||
</ul>
|
||||
<h3><a name ="cont-6">The OpenStep functions</a></h3>
|
||||
<h3><a name ="cont-6">The OpenStep functions and types</a></h3>
|
||||
<ul>
|
||||
<li><a href ="NSFunctions.html">Functions</a>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
<p>Date: $Date$</p>
|
||||
<h2><a name ="cont-0">NSCalendarDate</a></h2>
|
||||
<h2><a name ="NSCalendarDate">NSCalendarDate</a></h2>
|
||||
<p><b>Declared in: </b> Foundation/NSDate.h</p>
|
||||
<p><b>Declared in: </b> Foundation/NSCalendarDate.h</p>
|
||||
<p><b>Inherits from: </b> NSDate</p>
|
||||
<p><b>Conforms to: </b> NSCoding
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -56,6 +56,12 @@
|
|||
<h3><a name ="method-1">characterSetWithBitmapRepresentation:</a></h3>
|
||||
+ (NSCharacterSet*) <b>characterSetWithBitmapRepresentation:</b> (NSData*)data;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a character set containing characters as encoded in the
|
||||
<em>data</em> object.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-2">characterSetWithCharactersInString:</a></h3>
|
||||
|
|
@ -81,16 +87,34 @@
|
|||
<h3><a name ="method-6">decimalDigitCharacterSet</a></h3>
|
||||
+ (NSCharacterSet*) <b>decimalDigitCharacterSet</b>;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a character set containing characters that represent
|
||||
the decimal digits 0 through 9.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-7">decomposableCharacterSet</a></h3>
|
||||
+ (NSCharacterSet*) <b>decomposableCharacterSet</b>;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a character set containing individual charactars that
|
||||
can be represented also by a composed character sequence.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-8">illegalCharacterSet</a></h3>
|
||||
+ (NSCharacterSet*) <b>illegalCharacterSet</b>;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a character set containing unassigned (illegal)
|
||||
character values.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-9">letterCharacterSet</a></h3>
|
||||
|
|
@ -101,6 +125,13 @@
|
|||
<h3><a name ="method-10">lowercaseLetterCharacterSet</a></h3>
|
||||
+ (NSCharacterSet*) <b>lowercaseLetterCharacterSet</b>;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a character set that contains the lowercase characters.
|
||||
This set does not include caseless characters, only those that
|
||||
have corresponding characters in uppercase and/or titlecase.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-11">nonBaseCharacterSet</a></h3>
|
||||
|
|
@ -116,32 +147,68 @@
|
|||
<h3><a name ="method-13">uppercaseLetterCharacterSet</a></h3>
|
||||
+ (NSCharacterSet*) <b>uppercaseLetterCharacterSet</b>;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a character set that contains the uppercase characters.
|
||||
This set does not include caseless characters, only those that
|
||||
have corresponding characters in lowercase and/or titlecase.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-14">whitespaceAndNewlineCharacterSet</a></h3>
|
||||
+ (NSCharacterSet*) <b>whitespaceAndNewlineCharacterSet</b>;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a character set that contains the whitespace characters,
|
||||
plus the newline characters, values 0x000A and 0x000D.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-15">whitespaceCharacterSet</a></h3>
|
||||
+ (NSCharacterSet*) <b>whitespaceCharacterSet</b>;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a character set that contains the whitespace characters.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<hr><h2>Instances Methods </h2>
|
||||
<h3><a name ="method-16">bitmapRepresentation</a></h3>
|
||||
- (NSData*) <b>bitmapRepresentation</b>;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a bitmap representation of the receiver's character set
|
||||
suitable for archiving or writing to a file, in an NSData object.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-17">characterIsMember:</a></h3>
|
||||
- (BOOL) <b>characterIsMember:</b> (unichar)aCharacter;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns YES if the receiver contains <em>aCharacter</em>, NO if
|
||||
it does not.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-18">invertedSet</a></h3>
|
||||
- (NSCharacterSet*) <b>invertedSet</b>;<br>
|
||||
|
||||
<p>
|
||||
|
||||
Returns a character set containing only characters that the
|
||||
receiver does not contain.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -11,7 +11,43 @@
|
|||
</dl>
|
||||
<p>Version: $Revision$</p>
|
||||
<p>Date: $Date$</p>
|
||||
<h2><a name ="cont-0">NSFunctions</a></h2>
|
||||
<h2><a name ="cont-0">Functions</a></h2>
|
||||
<h2><a name ="cont-1">Types</a></h2>
|
||||
<h3><a name ="NSRange">NSRange</a></h3>
|
||||
<p><b>Declared in: </b> Foundation/NSRange.h</p>
|
||||
<b>typedef </b>
|
||||
struct { unsigned long location; unsigned long length; }
|
||||
NSRange<br>
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
The NSRange type is used to specify ranges of locations,
|
||||
typically items in an array, characters in a string, and bytes
|
||||
in a data object.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
||||
As 'boundary' or 'fencepost' errors are a particularly common
|
||||
problem in programming, it is important that you understand
|
||||
how an NSRange works.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
||||
An NSRange consists of a location and a length. The points
|
||||
that are considered to lie in a range are the integers from
|
||||
the location to the location plus the length, so the number
|
||||
of points in a range is the length of the range plus one.<br>
|
||||
However, if you consider these points like the marks on a
|
||||
ruler, you can only store information <strong>between</strong>
|
||||
points. So the number of items that can be stored in a range
|
||||
is the length of the range.
|
||||
</p>
|
||||
|
||||
|
||||
<hr>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -91,11 +91,31 @@
|
|||
<h3><a name ="method-8">mutableBytes</a></h3>
|
||||
- (void*) <b>mutableBytes</b>;<br>
|
||||
|
||||
Returns a pointer to the data storage of the receiver.<br>
|
||||
Modifications to the memory pointed to by this pointer will
|
||||
change the contents of the object. It is important that
|
||||
your code should not try to modify the memory beyond the
|
||||
number of bytes given by the <code>-length</code> method.<br>
|
||||
NB. if the object is released, or any method that changes its
|
||||
size or content is called, then the pointer previously returned
|
||||
by this method may cease to be valid.<br>
|
||||
This is a 'primitive' method ... you need to implement it
|
||||
if you write a subclass of NSMutableData.
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-9">replaceBytesInRange:withBytes:</a></h3>
|
||||
- (void) <b>replaceBytesInRange:</b> (NSRange)range <b>withBytes:</b> (const void*)bytes;<br>
|
||||
|
||||
Replaces the bytes of data in the specified range with a
|
||||
copy of the new bytes supplied.<br>
|
||||
If the location of the range specified lies beyond the end
|
||||
of the data (<code>[self length] < range.location</code>)
|
||||
then a range exception is raised.<br>
|
||||
Otherwise, if the range specified extends beyond the end
|
||||
of the data, then the size of the data is increased to
|
||||
accomodate the new bytes.<br>
|
||||
This is a 'primitive' method ... you need to implement it
|
||||
if you write a subclass of NSMutableData.
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-10">resetBytesInRange:</a></h3>
|
||||
|
|
|
|||
|
|
@ -151,6 +151,9 @@ Standards: GNUstep<br>
|
|||
<h3><a name ="method-12">instanceMethodSignatureForSelector:</a></h3>
|
||||
+ (NSMethodSignature*) <b>instanceMethodSignatureForSelector:</b> (SEL)aSelector;<br>
|
||||
|
||||
Returns a method signature object representing the
|
||||
method implemented for instsances of this class which
|
||||
corresponds to the supplied selector.
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-13">instancesRespondToSelector:</a></h3>
|
||||
|
|
@ -316,6 +319,9 @@ Standards: GNUstep<br>
|
|||
<h3><a name ="method-38">methodSignatureForSelector:</a></h3>
|
||||
- (NSMethodSignature*) <b>methodSignatureForSelector:</b> (SEL)aSelector;<br>
|
||||
|
||||
Returns a method signature object representing the
|
||||
method implemented in this object which corresponds to
|
||||
the supplied selector.
|
||||
|
||||
<hr>
|
||||
<h3><a name ="method-39">mutableCopy</a></h3>
|
||||
|
|
|
|||
Loading…
Reference in a new issue