String documentation added for raplacing strings with strings

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@7196 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald 2000-08-13 05:35:16 +00:00
parent ee3d710d31
commit 0576bccce7
4 changed files with 119 additions and 18 deletions

View file

@ -62,6 +62,20 @@
<desc>
</desc>
</method>
<method type="void">
<sel>replaceString:</sel>
<arg type="NSString*">aString</arg>
<sel>withString:</sel>
<arg type="NSString*">replacement</arg>
<desc>
Replaces any (and all) occurrances of <em>aString</em> in the
receiver by <em>replacement</em>.
Has no effect if <em>aString</em> does not occur within the
receiver. NB. an empty string is not considered to exist within
the receiver.
</desc>
<standards><GNUstep/><NotMacOS-X/><NotOpenStep/></standards>
</method>
<method type="void">
<sel>setString:</sel>
<arg type="NSString*">aString</arg>

View file

@ -30,7 +30,8 @@
<li><a href="NSMutableString.html#method-4">-initWithCapacity:</a>
<li><a href="NSMutableString.html#method-5">-insertString:</a>
<li><a href="NSMutableString.html#method-6">-replaceCharactersInRange:withString:</a>
<li><a href="NSMutableString.html#method-7">-setString:</a>
<li><a href="NSMutableString.html#method-7">-replaceString:withString:</a>
<li><a href="NSMutableString.html#method-8">-setString:</a>
</ul>
<hr>
<h2><a name="method-0">stringWithCapacity:</a></h2>
@ -68,7 +69,18 @@
<hr>
<h2><a name="method-7">setString:</a></h2>
<h2><a name="method-7">replaceString:withString:</a></h2>
- (void) <b>replaceString:</b> (NSString*)aString <b>withString:</b> (NSString*)replacement;<br>
Standards: GNUstep NotMacOS-X NotOpenStep<br>
Replaces any (and all) occurrances of <em>aString</em> in the
receiver by <em>replacement</em>.
Has no effect if <em>aString</em> does not occur within the
receiver. NB. an empty string is not considered to exist within
the receiver.
<hr>
<h2><a name="method-8">setString:</a></h2>
- (void) <b>setString:</b> (NSString*)aString;<br>

View file

@ -479,12 +479,18 @@
<sel>rangeOfString:</sel>
<arg type="NSString*">aString</arg>
<desc>
Invokes <em>rangeOfString:options:</em> with the options mask
set to zero.
</desc>
</method>
<method type="NSRange">
<sel>rangeOfString:</sel>
<arg type="NSString*">aString</arg>
<sel>options:</sel>
<arg type="unsigned int">mask</arg>
<desc>
Invokes <em>rangeOfString:options:range</em> with the range set
set to the range of the whole of the reciever.
</desc>
</method>
<method type="NSRange">
@ -495,6 +501,25 @@
<sel>range:</sel>
<arg type="NSRange">aRange</arg>
<desc>
Returns the range giving the location and length of the first
occurrence of <em>subString</em> within <em>aRange</em>.
<br/>
If <em>subString</em> does not exist in the receiver (an empty
string is <em>never</em> considered to exist in the receiver),
the length of the returned range is zero.
<br/>
If <em>substring</em> is nil, an exception is raised.
<br/>
If any part of <em>aRange</em> lies outside the range of the
receiver, an exception is raised.
<br/>
The optionsm mask may contain the following options -
<list>
<item>NSCaseInsensitiveSearch</item>
<item>NSLiteralSearch</item>
<item>NSBackwardsSearch</item>
<item>NSAnchoredSearch</item>
</list>
</desc>
</method>
<method type="NSStringEncoding">
@ -546,6 +571,20 @@
<desc>
</desc>
</method>
<method type="NSString*">
<sel>stringByReplacingString:</sel>
<arg type="NSString*">aString</arg>
<sel>withString:</sel>
<arg type="NSString*">replacement</arg>
<desc>
Returns a string in which any (and all) occurrances of
<em>aString</em> in the receiver have been replaced by
<em>replacement</em>. Returns the receiver if <em>aString</em>
does not occur within the receiver. NB. an empty string is
not considered to exist within the receiver.
</desc>
<standards><GNUstep/><NotMacOS-X/><NotOpenStep/></standards>
</method>
<method type="NSArray*">
<sel>stringsByAppendingPaths:</sel>
<arg type="NSArray*">paths</arg>

View file

@ -43,8 +43,8 @@ A constant NSString can be created using the following syntax: <code>@"..."</cod
<li><a href="NSString.html#method-3">+localizedStringWithFormat:</a>
<li><a href="NSString.html#method-4">+pathWithComponents:</a>
<li><a href="NSString.html#method-5">+string</a>
<li><a href="NSString.html#method-8">+stringWithCString:</a>
<li><a href="NSString.html#method-9">+stringWithCString:</a>
<li><a href="NSString.html#method-8">+stringWithCString:</a>
<li><a href="NSString.html#method-6">+stringWithCharacters:length:</a>
<li><a href="NSString.html#method-7">+stringWithContentsOfFile:</a>
<li><a href="NSString.html#method-10">+stringWithFormat:</a>
@ -106,7 +106,7 @@ A constant NSString can be created using the following syntax: <code>@"..."</cod
<li><a href="NSString.html#method-68">-rangeOfCharacterFromSet:options:range:</a>
<li><a href="NSString.html#method-69">-rangeOfComposedCharacterSequenceAtIndex:</a>
<li><a href="NSString.html#method-70">-rangeOfString:</a>
<li><a href="NSString.html#method-71">-rangeOfString:</a>
<li><a href="NSString.html#method-71">-rangeOfString:options:</a>
<li><a href="NSString.html#method-72">-rangeOfString:options:range:</a>
<li><a href="NSString.html#method-73">-smallestEncoding</a>
<li><a href="NSString.html#method-74">-stringByAbbreviatingWithTildeInPath</a>
@ -117,12 +117,13 @@ A constant NSString can be created using the following syntax: <code>@"..."</cod
<li><a href="NSString.html#method-79">-stringByDeletingLastPathComponent</a>
<li><a href="NSString.html#method-80">-stringByDeletingPathExtension</a>
<li><a href="NSString.html#method-81">-stringByExpandingTildeInPath</a>
<li><a href="NSString.html#method-82">-stringsByAppendingPaths:</a>
<li><a href="NSString.html#method-83">-substringFromIndex:</a>
<li><a href="NSString.html#method-84">-substringToIndex:</a>
<li><a href="NSString.html#method-85">-substringWithRange:</a>
<li><a href="NSString.html#method-86">-uppercaseString</a>
<li><a href="NSString.html#method-87">-writeToFile:atomically:</a>
<li><a href="NSString.html#method-82">-stringByReplacingString:withString:</a>
<li><a href="NSString.html#method-83">-stringsByAppendingPaths:</a>
<li><a href="NSString.html#method-84">-substringFromIndex:</a>
<li><a href="NSString.html#method-85">-substringToIndex:</a>
<li><a href="NSString.html#method-86">-substringWithRange:</a>
<li><a href="NSString.html#method-87">-uppercaseString</a>
<li><a href="NSString.html#method-88">-writeToFile:atomically:</a>
</ul>
<hr>
<h2><a name="method-0">availableStringEncodings</a></h2>
@ -487,16 +488,40 @@ Returns the localized name of the encoding specified by <var>encoding</var>.</p>
<h2><a name="method-70">rangeOfString:</a></h2>
- (NSRange) <b>rangeOfString:</b> (NSString*)aString;<br>
Invokes <em>rangeOfString:options:</em> with the options mask
set to zero.
<hr>
<h2><a name="method-71">rangeOfString:</a></h2>
- (NSRange) <b>rangeOfString:</b> (NSString*)aString;<br>
<h2><a name="method-71">rangeOfString:options:</a></h2>
- (NSRange) <b>rangeOfString:</b> (NSString*)aString <b>options:</b> (unsigned int)mask;<br>
Invokes <em>rangeOfString:options:range</em> with the range set
set to the range of the whole of the reciever.
<hr>
<h2><a name="method-72">rangeOfString:options:range:</a></h2>
- (NSRange) <b>rangeOfString:</b> (NSString*)subString <b>options:</b> (unsigned int)mask <b>range:</b> (NSRange)aRange;<br>
Returns the range giving the location and length of the first
occurrence of <em>subString</em> within <em>aRange</em>.
<br>
If <em>subString</em> does not exist in the receiver (an empty
string is <em>never</em> considered to exist in the receiver),
the length of the returned range is zero.
<br>
If <em>substring</em> is nil, an exception is raised.
<br>
If any part of <em>aRange</em> lies outside the range of the
receiver, an exception is raised.
<br>
The optionsm mask may contain the following options -
<ul>
<li>NSCaseInsensitiveSearch
<li>NSLiteralSearch
<li>NSBackwardsSearch
<li>NSAnchoredSearch
</ul>
<hr>
<h2><a name="method-73">smallestEncoding</a></h2>
@ -544,32 +569,43 @@ Returns the localized name of the encoding specified by <var>encoding</var>.</p>
<hr>
<h2><a name="method-82">stringsByAppendingPaths:</a></h2>
<h2><a name="method-82">stringByReplacingString:withString:</a></h2>
- (NSString*) <b>stringByReplacingString:</b> (NSString*)aString <b>withString:</b> (NSString*)replacement;<br>
Standards: GNUstep NotMacOS-X NotOpenStep<br>
Returns a string in which any (and all) occurrances of
<em>aString</em> in the receiver have been replaced by
<em>replacement</em>. Returns the receiver if <em>aString</em>
does not occur within the receiver. NB. an empty string is
not considered to exist within the receiver.
<hr>
<h2><a name="method-83">stringsByAppendingPaths:</a></h2>
- (NSArray*) <b>stringsByAppendingPaths:</b> (NSArray*)paths;<br>
<hr>
<h2><a name="method-83">substringFromIndex:</a></h2>
<h2><a name="method-84">substringFromIndex:</a></h2>
- (NSString*) <b>substringFromIndex:</b> (unsigned int)anIndex;<br>
<hr>
<h2><a name="method-84">substringToIndex:</a></h2>
<h2><a name="method-85">substringToIndex:</a></h2>
- (NSString*) <b>substringToIndex:</b> (unsigned int)anIndex;<br>
<hr>
<h2><a name="method-85">substringWithRange:</a></h2>
<h2><a name="method-86">substringWithRange:</a></h2>
- (NSString*) <b>substringWithRange:</b> (NSRange)aRange;<br>
<hr>
<h2><a name="method-86">uppercaseString</a></h2>
<h2><a name="method-87">uppercaseString</a></h2>
- (NSString*) <b>uppercaseString</b>;<br>
<hr>
<h2><a name="method-87">writeToFile:atomically:</a></h2>
<h2><a name="method-88">writeToFile:atomically:</a></h2>
- (BOOL) <b>writeToFile:</b> (NSString*)path <b>atomically:</b> (BOOL)flag;<br>