gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-05-01 20:40:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fixed typo and provided overall description of parsing

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@10667 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
CaS 2001-08-07 11:34:00 +00:00
parent 7fe89e62d8
commit fe0730b760
2 changed files with 26 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Documentation/gsdoc/GSMime.gsdoc
View file

@ -43,7 +43,7 @@
<heading>The classes</heading> <heading>The classes</heading>
<list> <list>
<item><uref url="GSMimeDocument.html">GSMimeDocument</uref></item> <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> </list>
</section> </section>
</chapter> </chapter>

27
Documentation/gsdoc/GSMimeParser.gsdoc
View file

@ -22,6 +22,17 @@
into GSMimeDocument objects. Each parser object maintains into GSMimeDocument objects. Each parser object maintains
an associated document into which data is stored. an associated document into which data is stored.
</p> </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> </desc>
<method type="GSMimeParser*" factory="yes"> <method type="GSMimeParser*" factory="yes">
@ -128,10 +139,20 @@
<sel>parse:</sel> <sel>parse:</sel>
<arg type="NSData*">rawData</arg> <arg type="NSData*">rawData</arg>
<desc> <desc>
<p>
This method is called repeatedly to pass raw mime data into This method is called repeatedly to pass raw mime data into
the parser. It should be called with a nil argument at the the parser. It returns <code>YES</code> as long as it wants
end of the data - to inform the parser that it has been given more data to complete parsing of a document, and <code>NO</code>
all the available information. 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> </desc>
</method> </method>