From 76c060d5d9e98a2c719f75e9af13083e09e557fc Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Thu, 18 Jan 2007 08:49:59 +0000
Subject: [PATCH] Return values

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227485 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/phar/functions/Phar-getModified.xml               | 4 ++--
 reference/phar/functions/Phar-loadPhar.xml                  | 4 ++--
 reference/phar/functions/Phar-mapPhar.xml                   | 3 ++-
 reference/phar/functions/Phar-offsetGet.xml                 | 4 ++--
 reference/phar/functions/Phar-offsetSet.xml                 | 6 +++---
 reference/phar/functions/Phar-offsetUnset.xml               | 4 ++--
 reference/phar/functions/PharFileInfo-getCRC32.xml          | 4 ++--
 reference/phar/functions/PharFileInfo-getCompressedSize.xml | 4 ++--
 reference/phar/functions/PharFileInfo-getPharFlags.xml      | 4 ++--
 reference/phar/functions/apiVersion.xml                     | 4 ++--
 reference/phar/functions/canCompress.xml                    | 4 ++--
 11 files changed, 23 insertions(+), 22 deletions(-)

diff --git a/reference/phar/functions/Phar-getModified.xml b/reference/phar/functions/Phar-getModified.xml
index d6c0fed7cc..ad46c63f8e 100644
--- a/reference/phar/functions/Phar-getModified.xml
+++ b/reference/phar/functions/Phar-getModified.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.Phar-getModified">
  <refnamediv>
   <refname>Phar->getModified</refname>
@@ -27,7 +27,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &true; if the phar has been modified since opened, &false; if not
+   &true; if the phar has been modified since opened, &false; if not.
   </para>
  </refsect1>
 
diff --git a/reference/phar/functions/Phar-loadPhar.xml b/reference/phar/functions/Phar-loadPhar.xml
index d6b71d3c48..51ca7f6b69 100644
--- a/reference/phar/functions/Phar-loadPhar.xml
+++ b/reference/phar/functions/Phar-loadPhar.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry id="function.Phar-loadPhar">
  <refnamediv>
   <refname>Phar::loadPhar</refname>
@@ -49,7 +49,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   returns &true; if successful, &false; otherwise
+   &return.success;
   </para>
  </refsect1>
 
diff --git a/reference/phar/functions/Phar-mapPhar.xml b/reference/phar/functions/Phar-mapPhar.xml
index 3a7b970b44..39a9057d5b 100644
--- a/reference/phar/functions/Phar-mapPhar.xml
+++ b/reference/phar/functions/Phar-mapPhar.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry id="function.Phar-mapPhar">
  <refnamediv>
   <refname>Phar::mapPhar</refname>
@@ -36,6 +36,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
+   &return.success;
   </para>
  </refsect1>
 
diff --git a/reference/phar/functions/Phar-offsetGet.xml b/reference/phar/functions/Phar-offsetGet.xml
index b3f307f420..dc4e2b7365 100644
--- a/reference/phar/functions/Phar-offsetGet.xml
+++ b/reference/phar/functions/Phar-offsetGet.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.Phar-offsetGet">
  <refnamediv>
   <refname>Phar::offsetGet</refname>
@@ -38,7 +38,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   a <classname>PharFileInfo</classname> object is returned that can be used to
+   A <classname>PharFileInfo</classname> object is returned that can be used to
    iterate over a file's contents or to retrieve information about the current file.
   </para>
  </refsect1>
diff --git a/reference/phar/functions/Phar-offsetSet.xml b/reference/phar/functions/Phar-offsetSet.xml
index 29abf92c8d..bf19e60337 100644
--- a/reference/phar/functions/Phar-offsetSet.xml
+++ b/reference/phar/functions/Phar-offsetSet.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry id="function.Phar-offsetSet">
  <refnamediv>
   <refname>Phar::offsetSet</refname>
@@ -37,7 +37,7 @@
      <term><parameter>value</parameter></term>
      <listitem>
       <para>
-       Its description
+       Content of the file.
       </para>
      </listitem>
     </varlistentry>
@@ -47,7 +47,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   no return values
+   No return values.
   </para>
  </refsect1>
 
diff --git a/reference/phar/functions/Phar-offsetUnset.xml b/reference/phar/functions/Phar-offsetUnset.xml
index 1445582087..2a3503108c 100644
--- a/reference/phar/functions/Phar-offsetUnset.xml
+++ b/reference/phar/functions/Phar-offsetUnset.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry id="function.Phar-offsetUnset">
  <refnamediv>
   <refname>Phar::offsetUnset</refname>
@@ -41,7 +41,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &true; if successful, &false; on failure
+   &return.success;
   </para>
  </refsect1>
 
diff --git a/reference/phar/functions/PharFileInfo-getCRC32.xml b/reference/phar/functions/PharFileInfo-getCRC32.xml
index 3ee59aed15..83208e0e2c 100644
--- a/reference/phar/functions/PharFileInfo-getCRC32.xml
+++ b/reference/phar/functions/PharFileInfo-getCRC32.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.PharFileInfo-getCRC32">
  <refnamediv>
   <refname>PharFileInfo-&gt;getCRC32</refname>
@@ -21,7 +21,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   the <function>crc32</function> checksum of the file within the Phar archive.
+   The <function>crc32</function> checksum of the file within the Phar archive.
   </para>
  </refsect1>
 
diff --git a/reference/phar/functions/PharFileInfo-getCompressedSize.xml b/reference/phar/functions/PharFileInfo-getCompressedSize.xml
index f16690cf29..3eeb5adb3b 100644
--- a/reference/phar/functions/PharFileInfo-getCompressedSize.xml
+++ b/reference/phar/functions/PharFileInfo-getCompressedSize.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.PharFileInfo-getCompressedSize">
  <refnamediv>
   <refname>PharFileInfo-&gt;getCompressedSize</refname>
@@ -21,7 +21,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   the size in bytes of the file within the Phar archive on disk.
+   The size in bytes of the file within the Phar archive on disk.
   </para>
  </refsect1>
 
diff --git a/reference/phar/functions/PharFileInfo-getPharFlags.xml b/reference/phar/functions/PharFileInfo-getPharFlags.xml
index 2e7afe4545..3637a14979 100644
--- a/reference/phar/functions/PharFileInfo-getPharFlags.xml
+++ b/reference/phar/functions/PharFileInfo-getPharFlags.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.PharFileInfo-getPharFlags">
  <refnamediv>
   <refname>PharFileInfo-&gt;getPharFlags</refname>
@@ -20,7 +20,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   the size in bytes of the file within the Phar archive on disk.
+   The size in bytes of the file within the Phar archive on disk.
   </para>
  </refsect1>
 
diff --git a/reference/phar/functions/apiVersion.xml b/reference/phar/functions/apiVersion.xml
index 9ce1f7a7eb..d927fa21bd 100644
--- a/reference/phar/functions/apiVersion.xml
+++ b/reference/phar/functions/apiVersion.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.apiVersion">
  <refnamediv>
   <refname>apiVersion</refname>
@@ -27,7 +27,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   The API version string as in <literal>&quot;1.0.0&quot;</literal>
+   The API version string as in <literal>&quot;1.0.0&quot;</literal>.
   </para>
  </refsect1>
  <refsect1 role="examples">
diff --git a/reference/phar/functions/canCompress.xml b/reference/phar/functions/canCompress.xml
index 8109cbf19b..d0b5dbf21e 100644
--- a/reference/phar/functions/canCompress.xml
+++ b/reference/phar/functions/canCompress.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.canCompress">
  <refnamediv>
   <refname>canCompress</refname>
@@ -26,7 +26,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &true; if compression/decompression is available, &false; if not
+   &true; if compression/decompression is available, &false; if not.
   </para>
  </refsect1>