From d4d09c40aa5d89a15d6f06b6c58d7386dcebbfa4 Mon Sep 17 00:00:00 2001
From: CaS <CaS@72102866-910b-0410-8b05-ffd578937521>
Date: Fri, 8 Jun 2001 11:09:32 +0000
Subject: [PATCH] Corrected spec for primitive methods

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@10116 72102866-910b-0410-8b05-ffd578937521
---
 Documentation/gsdoc/NSMutableData.gsdoc | 55 ++++++++++++++++---------
 1 file changed, 35 insertions(+), 20 deletions(-)

diff --git a/Documentation/gsdoc/NSMutableData.gsdoc b/Documentation/gsdoc/NSMutableData.gsdoc
index c65b9e63a..e4feb5725 100644
--- a/Documentation/gsdoc/NSMutableData.gsdoc
+++ b/Documentation/gsdoc/NSMutableData.gsdoc
@@ -71,16 +71,22 @@
         <method type="void*">
           <sel>mutableBytes</sel>
           <desc>
-	    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.
+	    <p>
+	      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.
+	    </p>
+	    <p>
+	      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.
+	    </p>
+	    <p>
+	      This is a 'primitive' method ... you need to implement it
+	      if you write a subclass of NSMutableData.
+	    </p>
           </desc>
         </method>
         <method type="void">
@@ -89,16 +95,16 @@
           <sel>withBytes:</sel>
           <arg type="const void*">bytes</arg>
           <desc>
-	    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] &lt; 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.
+	    <p>
+	      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] &lt; 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 />
+	    </p>
           </desc>
         </method>
         <method type="void">
@@ -163,6 +169,15 @@
           <sel>setLength:</sel>
           <arg type="unsigned int">length</arg>
           <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>
         </method>
       </class>