cvs: peardoc /en/package/mail/mail-mbox/mail-mbox -move.xml -process.xml get.xml getdebug.xml gettmpdir.xml insert.xml mail-mbox.xml open.xml remove.xml setdebug.xml settmpdir.xml size.xml update.xml
[email protected] ("Ken Guest")
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <cvskguest1199472515@cvsserver> |
kguest Fri Jan 4 18:48:35 2008 UTC
Modified files:
/peardoc/en/package/mail/mail-mbox/mail-mbox -move.xml -process.xml
get.xml getdebug.xml
gettmpdir.xml
insert.xml
mail-mbox.xml open.xml
remove.xml
setdebug.xml
settmpdir.xml size.xml
update.xml
Log:
some minor corrections regarding grammar and readability
kguest-20080104184835.txt
(text/plain, 13.7 KB)
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/-move.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/-move.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/-move.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/-move.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/-move.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/-move.xml Fri Jan 4 18:48:34 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.-move">
<refnamediv>
<refname>
@@ -27,7 +27,7 @@
</refsynopsisdiv>
<refsect1 id="package.mail.mail-mbox.mail-mbox.-move.desc">
&title.desc;
- <para>Used internally to copy the content of the temp file to the mbox file</para>
+ <para>Used internally to copy the content of the temp file to the mbox file.</para>
</refsect1>
<refsect1 id="package.mail.mail-mbox.mail-mbox.-move.param">
&title.param;
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/-process.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/-process.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/-process.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/-process.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/-process.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/-process.xml Fri Jan 4 18:48:34 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.-process">
<refnamediv>
<refname>
@@ -23,7 +23,7 @@
<para>
<itemizedlist>
<listitem>
- <para>Get start bytes and end bytes of each messages</para>
+ <para>Get start bytes and end bytes of each messages.</para>
</listitem>
</itemizedlist>
</para>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/get.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/get.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/get.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/get.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/get.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/get.xml Fri Jan 4 18:48:34 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.get">
<refnamediv>
<refname>
@@ -38,7 +38,7 @@
<parameter>$message</parameter>
</term>
<listitem>
- <para>The number of the message to retrieve</para>
+ <para>The number of the message to retrieve.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -48,7 +48,7 @@
&title.returns;
<para>
<emphasis>returns</emphasis>
- Return the message, <classname>PEAR_Error</classname> on error
+ Return the message, or <classname>PEAR_Error</classname> on error.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/getdebug.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/getdebug.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/getdebug.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/getdebug.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/getdebug.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/getdebug.xml Fri Jan 4 18:48:34 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.getdebug">
<refnamediv>
<refname>
@@ -21,14 +21,14 @@
<refsect1 id="package.mail.mail-mbox.mail-mbox.getdebug.desc">
&title.desc;
<para>
- Returns if debugging is enabled.
+ Returns true if debugging is enabled.
</para>
</refsect1>
<refsect1 id="package.mail.mail-mbox.mail-mbox.getdebug.returns">
&title.returns;
<para>
<emphasis>returns</emphasis>
- If debug is enabled.
+ true if debug is enabled.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/gettmpdir.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/gettmpdir.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/gettmpdir.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/gettmpdir.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/gettmpdir.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/gettmpdir.xml Fri Jan 4 18:48:34 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.gettmpdir">
<refnamediv>
<refname>
@@ -28,7 +28,7 @@
&title.returns;
<para>
<emphasis>returns</emphasis>
- The temporary directory
+ The temporary directory.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/insert.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/insert.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/insert.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/insert.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/insert.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/insert.xml Fri Jan 4 18:48:34 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.insert">
<refnamediv>
<refname>
@@ -30,11 +30,11 @@
<refsect1 id="package.mail.mail-mbox.mail-mbox.insert.desc">
&title.desc;
<para>
- Mail_Mbox will insert the message according its offset.
- (Remember: message 3 is the forth message). The default is
- inserting it AFTER the last message (offset = null).
+ Mail_Mbox will insert the message according to the specified offset.
+ (Remember: message 3 is the fourth message). The default is to insert
+ the message AFTER the last message (offset = null).
</para>
- <para>Note: Mail_Mbox automatically adds \n\n at end of the message</para>
+ <para>Note: Mail_Mbox automatically adds \n\n at end of the message.</para>
</refsect1>
<refsect1 id="package.mail.mail-mbox.mail-mbox.insert.param">
&title.param;
@@ -46,7 +46,7 @@
<parameter>$content</parameter>
</term>
<listitem>
- <para>The content of the new message</para>
+ <para>The content of the new message.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -67,7 +67,7 @@
&title.returns;
<para>
<emphasis>returns</emphasis>
- Return true else <classname>PEAR_Error</classname> object.
+ Return true or the <classname>PEAR_Error</classname> object on failure.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/mail-mbox.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/mail-mbox.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/mail-mbox.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/mail-mbox.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/mail-mbox.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/mail-mbox.xml Fri Jan 4 18:48:34 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.mail-mbox">
<refnamediv>
<refname>
@@ -25,8 +25,9 @@
<refsect1 id="package.mail.mail-mbox.mail-mbox.mail-mbox.desc">
&title.desc;
<para>
- After creating it, you should use
- <link linkend="package.mail.mail-mbox.mail-mbox.open">open()</link>
+ After creating a new instance, you should use
+ <link linkend="package.mail.mail-mbox.mail-mbox.open">open()</link> to open
+ an mbox file.
</para>
</refsect1>
<refsect1 id="package.mail.mail-mbox.mail-mbox.mail-mbox.param">
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/open.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/open.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/open.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/open.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/open.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/open.xml Fri Jan 4 18:48:34 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.open">
<refnamediv>
<refname>
@@ -20,6 +20,6 @@
</refsynopsisdiv>
<refsect1 id="package.mail.mail-mbox.mail-mbox.open.desc">
&title.desc;
- <para>Also, this function will process the Mbox and create a cache that tells each message start and end bytes.</para>
+ <para>Also, this function will process the mbox file and create a cache that tells each message start and end bytes.</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/remove.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/remove.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/remove.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/remove.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/remove.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/remove.xml Fri Jan 4 18:48:35 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.remove">
<refnamediv>
<refname>
@@ -40,7 +40,7 @@
<listitem>
<para>
The number of the message to remove, or
- array of message ids to remove
+ array of message ids to remove.
</para>
</listitem>
</varlistentry>
@@ -51,7 +51,7 @@
&title.returns;
<para>
<emphasis>returns</emphasis>
- Return true else PEAR_Error
+ Return true or PEAR_Error object on failure.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/setdebug.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/setdebug.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/setdebug.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/setdebug.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/setdebug.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/setdebug.xml Fri Jan 4 18:48:35 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.setdebug">
<refnamediv>
<refname>
@@ -37,7 +37,7 @@
<parameter>$debug</parameter>
</term>
<listitem>
- <para>If debug is on or off</para>
+ <para>True if debug is on, otherwise false.</para>
</listitem>
</varlistentry>
</variablelist>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/settmpdir.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/settmpdir.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/settmpdir.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/settmpdir.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/settmpdir.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/settmpdir.xml Fri Jan 4 18:48:35 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.settmpdir">
<refnamediv>
<refname>
@@ -37,7 +37,7 @@
<parameter>$tmpdir</parameter>
</term>
<listitem>
- <para>The new temporary directory</para>
+ <para>The new temporary directory.</para>
</listitem>
</varlistentry>
</variablelist>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/size.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/size.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/size.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/size.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/size.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/size.xml Fri Jan 4 18:48:35 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.size">
<refnamediv>
<refname>
@@ -28,7 +28,7 @@
&title.returns;
<para>
<emphasis>returns</emphasis>
- Number of messages on Mbox (starting on 1, 0 if no message exists)
+ Number of messages on Mbox (starting on 1, 0 if no message exists).
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mbox/mail-mbox/update.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail-mbox/mail-mbox/update.xml
diff -u peardoc/en/package/mail/mail-mbox/mail-mbox/update.xml:1.2 peardoc/en/package/mail/mail-mbox/mail-mbox/update.xml:1.3
--- peardoc/en/package/mail/mail-mbox/mail-mbox/update.xml:1.2 Tue Sep 12 15:43:15 2006
+++ peardoc/en/package/mail/mail-mbox/mail-mbox/update.xml Fri Jan 4 18:48:35 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail-mbox.mail-mbox.update">
<refnamediv>
<refname>
@@ -43,7 +43,7 @@
<parameter>$message</parameter>
</term>
<listitem>
- <para>The number of Message to updated</para>
+ <para>The number of the Message to update.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -54,7 +54,7 @@
<parameter>$content</parameter>
</term>
<listitem>
- <para>The new content of the Message</para>
+ <para>The new content of the Message.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -64,7 +64,7 @@
&title.returns;
<para>
<emphasis>returns</emphasis>
- Return true if all is ok, else <classname>PEAR_Error</classname>
+ Return true if all is ok, otherwise <classname>PEAR_Error</classname>
</para>
</refsect1>
</refentry>