gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-05-31 16:50:58 +00:00
Code Issues Projects Releases Packages Wiki Activity

Corrected spec for primitive methods

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@10116 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
CaS 2001-06-08 11:09:32 +00:00
parent 7baae41ad8
commit d4d09c40aa
1 changed files with 35 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

55
Documentation/gsdoc/NSMutableData.gsdoc
View file

@ -71,16 +71,22 @@
<method type="void*"> <method type="void*">
<sel>mutableBytes</sel> <sel>mutableBytes</sel>
<desc> <desc>
Returns a pointer to the data storage of the receiver.<br /> <p>
Modifications to the memory pointed to by this pointer will Returns a pointer to the data storage of the receiver.<br />
change the contents of the object. It is important that Modifications to the memory pointed to by this pointer will
your code should not try to modify the memory beyond the change the contents of the object. It is important that
number of bytes given by the <code>-length</code> method.<br /> your code should not try to modify the memory beyond the
NB. if the object is released, or any method that changes its number of bytes given by the <code>-length</code> method.
size or content is called, then the pointer previously returned </p>
by this method may cease to be valid.<br /> <p>
This is a 'primitive' method ... you need to implement it NB. if the object is released, or any method that changes its
if you write a subclass of NSMutableData. size or content is called, then the pointer previously returned
by this method may cease to be valid.
</p>
<p>
This is a 'primitive' method ... you need to implement it
if you write a subclass of NSMutableData.
</p>
</desc> </desc>
</method> </method>
<method type="void"> <method type="void">
@ -89,16 +95,16 @@
<sel>withBytes:</sel> <sel>withBytes:</sel>
<arg type="const void*">bytes</arg> <arg type="const void*">bytes</arg>
<desc> <desc>
Replaces the bytes of data in the specified range with a <p>
copy of the new bytes supplied.<br /> Replaces the bytes of data in the specified range with a
If the location of the range specified lies beyond the end copy of the new bytes supplied.<br />
of the data (<code>[self length] &lt; range.location</code>) If the location of the range specified lies beyond the end
then a range exception is raised.<br /> of the data (<code>[self length] &lt; range.location</code>)
Otherwise, if the range specified extends beyond the end then a range exception is raised.<br />
of the data, then the size of the data is increased to Otherwise, if the range specified extends beyond the end
accomodate the new bytes.<br /> of the data, then the size of the data is increased to
This is a 'primitive' method ... you need to implement it accomodate the new bytes.<br />
if you write a subclass of NSMutableData. </p>
</desc> </desc>
</method> </method>
<method type="void"> <method type="void">
@ -163,6 +169,15 @@
<sel>setLength:</sel> <sel>setLength:</sel>
<arg type="unsigned int">length</arg> <arg type="unsigned int">length</arg>
<desc> <desc>
<p>
Sets the length of the NSMutableData object.
If the length is increased, the newly allocated data area
is filled with zero bytes.
</p>
<p>
This is a 'primitive' method ... you need to implement it
if you write a subclass of NSMutableData.
</p>
</desc> </desc>
</method> </method>
</class> </class>