From fe0730b7604a0965b561adbddff640d1e2cef71c Mon Sep 17 00:00:00 2001
From: CaS <CaS@72102866-910b-0410-8b05-ffd578937521>
Date: Tue, 7 Aug 2001 11:34:00 +0000
Subject: [PATCH] Fixed typo and provided overall description of parsing

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@10667 72102866-910b-0410-8b05-ffd578937521
---
 Documentation/gsdoc/GSMime.gsdoc       |  2 +-
 Documentation/gsdoc/GSMimeParser.gsdoc | 29 ++++++++++++++++++++++----
 2 files changed, 26 insertions(+), 5 deletions(-)

diff --git a/Documentation/gsdoc/GSMime.gsdoc b/Documentation/gsdoc/GSMime.gsdoc
index c4ac095f4..09fe98c25 100644
--- a/Documentation/gsdoc/GSMime.gsdoc
+++ b/Documentation/gsdoc/GSMime.gsdoc
@@ -43,7 +43,7 @@
           <heading>The classes</heading>
           <list>
             <item><uref url="GSMimeDocument.html">GSMimeDocument</uref></item>
-            <item><uref url="GSMimeParser.html">GSMimearser</uref></item>
+            <item><uref url="GSMimeParser.html">GSMimeParser</uref></item>
           </list>
       </section>
     </chapter>
diff --git a/Documentation/gsdoc/GSMimeParser.gsdoc b/Documentation/gsdoc/GSMimeParser.gsdoc
index 1b2dc369c..f036d632d 100644
--- a/Documentation/gsdoc/GSMimeParser.gsdoc
+++ b/Documentation/gsdoc/GSMimeParser.gsdoc
@@ -22,6 +22,17 @@
 	    into GSMimeDocument objects.  Each parser object maintains
 	    an associated document into which data is stored.
 	  </p>
+	  <p>
+	    You supply the document to be parsed as one or more data
+	    items passed to the <code>Parse:</code> method, and (if
+	    the method always returns <code>YES</code>, you give it
+	    a final <code>nil</code> argument to mark the end of the
+	    document.
+	  </p>
+	  <p>
+	    On completion of parsing a valid document, the
+	    <code>document</code> method returns the resulting parsed document.
+	  </p>
 	</desc>
 
         <method type="GSMimeParser*" factory="yes">
@@ -128,10 +139,20 @@
           <sel>parse:</sel>
           <arg type="NSData*">rawData</arg>
           <desc>
-	    This method is called repeatedly to pass raw mime data into
-	    the parser.  It should be called with a nil argument at the
-	    end of the data - to inform the parser that it has been given
-	    all the available information.
+	    <p>
+	      This method is called repeatedly to pass raw mime data into
+	      the parser.  It returns <code>YES</code> as long as it wants
+	      more data to complete parsing of a document, and <code>NO</code>
+	      if parsing is complete, either due to having reached the end of
+	      a document or due to an error.
+	    </p>
+	    <p>
+	      Since it is not always possible to determine if the end of a
+	      MIME document has been reached from its content, the method
+	      may need to be called with a nil argument after you have
+	      passed all the data to it ... this tells it that the data
+	      is complete.
+	    </p>
           </desc>
         </method>