From ed112b333473a6c9c2d582bb7cde6e2f1aedaf1c Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nlopess@php.net>
Date: Fri, 11 Aug 2006 17:59:01 +0000
Subject: [PATCH] misc fixes

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@217996 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../zip/functions/ziparchive-addfile.xml      |   4 +-
 .../functions/ziparchive-addfromstring.xml    |   4 +-
 reference/zip/functions/ziparchive-close.xml  |   4 +-
 .../zip/functions/ziparchive-deleteindex.xml  |   4 +-
 .../zip/functions/ziparchive-deletename.xml   |   4 +-
 .../ziparchive-getarchivecomment.xml          |   8 +-
 .../functions/ziparchive-getcommentindex.xml  |   4 +-
 .../functions/ziparchive-getcommentname.xml   |   4 +-
 .../zip/functions/ziparchive-getnameindex.xml |   4 +-
 .../zip/functions/ziparchive-getstream.xml    |   4 +-
 .../zip/functions/ziparchive-renameindex.xml  |   4 +-
 .../zip/functions/ziparchive-renamename.xml   |   4 +-
 .../zip/functions/ziparchive-statindex.xml    |   6 +-
 .../zip/functions/ziparchive-statname.xml     |   8 +-
 reference/zip/reference.xml                   | 147 +++++++++---------
 15 files changed, 105 insertions(+), 108 deletions(-)

diff --git a/reference/zip/functions/ziparchive-addfile.xml b/reference/zip/functions/ziparchive-addfile.xml
index 2f202ae53d..3efe0a88e6 100644
--- a/reference/zip/functions/ziparchive-addfile.xml
+++ b/reference/zip/functions/ziparchive-addfile.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-addfile">
  <refnamediv>
   <refname>ZipArchive::addFile</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>boolean</type><methodname>ZipArchive::addFile</methodname>
+   <type>bool</type><methodname>ZipArchive::addFile</methodname>
    <methodparam><type>string</type><parameter>filename</parameter></methodparam>
    <methodparam choice="opt"><type>string</type><parameter>localname</parameter></methodparam>
   </methodsynopsis>
diff --git a/reference/zip/functions/ziparchive-addfromstring.xml b/reference/zip/functions/ziparchive-addfromstring.xml
index 0fddd411dc..325460834d 100644
--- a/reference/zip/functions/ziparchive-addfromstring.xml
+++ b/reference/zip/functions/ziparchive-addfromstring.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-addfromstring">
  <refnamediv>
   <refname>ZipArchive::addFromString</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>boolean</type><methodname>ZipArchive::addFromString</methodname>
+   <type>bool</type><methodname>ZipArchive::addFromString</methodname>
    <methodparam><type>string</type><parameter>localname</parameter></methodparam>
    <methodparam><type>string</type><parameter>contents</parameter></methodparam>
   </methodsynopsis>
diff --git a/reference/zip/functions/ziparchive-close.xml b/reference/zip/functions/ziparchive-close.xml
index 48e645ac92..c712544a72 100644
--- a/reference/zip/functions/ziparchive-close.xml
+++ b/reference/zip/functions/ziparchive-close.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-close">
  <refnamediv>
   <refname>ZipArchive::close</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>boolean</type><methodname>ZipArchive::close</methodname>
+   <type>bool</type><methodname>ZipArchive::close</methodname>
    <void/>
   </methodsynopsis>
   <para>
diff --git a/reference/zip/functions/ziparchive-deleteindex.xml b/reference/zip/functions/ziparchive-deleteindex.xml
index 2a183a59a1..3d7976337f 100644
--- a/reference/zip/functions/ziparchive-deleteindex.xml
+++ b/reference/zip/functions/ziparchive-deleteindex.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-deleteindex">
  <refnamediv>
   <refname>ZipArchive::deleteIndex</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>boolean</type><methodname>ZipArchive::deleteIndex</methodname>
+   <type>bool</type><methodname>ZipArchive::deleteIndex</methodname>
    <methodparam><type>integer</type><parameter>index</parameter></methodparam>
   </methodsynopsis>
   <para>
diff --git a/reference/zip/functions/ziparchive-deletename.xml b/reference/zip/functions/ziparchive-deletename.xml
index 05d2aacefa..990486044b 100644
--- a/reference/zip/functions/ziparchive-deletename.xml
+++ b/reference/zip/functions/ziparchive-deletename.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-deletename">
  <refnamediv>
   <refname>ZipArchive::deleteName</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>boolean</type><methodname>ZipArchive::deleteName</methodname>
+   <type>bool</type><methodname>ZipArchive::deleteName</methodname>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
   </methodsynopsis>
   <para>
diff --git a/reference/zip/functions/ziparchive-getarchivecomment.xml b/reference/zip/functions/ziparchive-getarchivecomment.xml
index 3e3b48e0bd..016ace2460 100644
--- a/reference/zip/functions/ziparchive-getarchivecomment.xml
+++ b/reference/zip/functions/ziparchive-getarchivecomment.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-getarchivecomment">
  <refnamediv>
   <refname>ZipArchive::getArchiveComment</refname>
@@ -8,17 +8,17 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>ZipArchive::getArchiveComment</methodname>
+   <type>string</type><methodname>ZipArchive::getArchiveComment</methodname>
    <void/>
   </methodsynopsis>
   <para>
-   Returns the Zip archive comment or false on failure.
+   Returns the Zip archive comment.
   </para>
  </refsect1>
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &return.success;
+   Returns the Zip archive comment or &false; on failure.
   </para>
  </refsect1>
  <refsect1 role="examples">
diff --git a/reference/zip/functions/ziparchive-getcommentindex.xml b/reference/zip/functions/ziparchive-getcommentindex.xml
index 9a216a0a0f..d55cc789eb 100644
--- a/reference/zip/functions/ziparchive-getcommentindex.xml
+++ b/reference/zip/functions/ziparchive-getcommentindex.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-getcommentindex">
  <refnamediv>
   <refname>ZipArchive::getCommentIndex</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>ZipArchive::getCommentIndex</methodname>
+   <type>string</type><methodname>ZipArchive::getCommentIndex</methodname>
    <methodparam><type>integer</type><parameter>index</parameter></methodparam>
    <methodparam choice="opt"><type>integer</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
diff --git a/reference/zip/functions/ziparchive-getcommentname.xml b/reference/zip/functions/ziparchive-getcommentname.xml
index d729f2247d..2fef495144 100644
--- a/reference/zip/functions/ziparchive-getcommentname.xml
+++ b/reference/zip/functions/ziparchive-getcommentname.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-getcommentname">
  <refnamediv>
   <refname>ZipArchive::getCommentName</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>ZipArchive::getCommentName</methodname>
+   <type>string</type><methodname>ZipArchive::getCommentName</methodname>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
    <methodparam choice="opt"><type>integer</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
diff --git a/reference/zip/functions/ziparchive-getnameindex.xml b/reference/zip/functions/ziparchive-getnameindex.xml
index ef82d458b6..f1626309a9 100644
--- a/reference/zip/functions/ziparchive-getnameindex.xml
+++ b/reference/zip/functions/ziparchive-getnameindex.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-getnameindex">
  <refnamediv>
   <refname>ZipArchive::getNameIndex</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>ZipArchive::getNameIndex</methodname>
+   <type>string</type><methodname>ZipArchive::getNameIndex</methodname>
    <methodparam><type>integer</type><parameter>index</parameter></methodparam>
   </methodsynopsis>
   <para>
diff --git a/reference/zip/functions/ziparchive-getstream.xml b/reference/zip/functions/ziparchive-getstream.xml
index 228fb7e56e..3fe298dd80 100644
--- a/reference/zip/functions/ziparchive-getstream.xml
+++ b/reference/zip/functions/ziparchive-getstream.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-getstream">
  <refnamediv>
   <refname>ZipArchive::getStream</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>ZipArchive::getStream</methodname>
+   <type>resource</type><methodname>ZipArchive::getStream</methodname>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
   </methodsynopsis>
   <para>
diff --git a/reference/zip/functions/ziparchive-renameindex.xml b/reference/zip/functions/ziparchive-renameindex.xml
index db3c80a1e7..ab88730bbd 100644
--- a/reference/zip/functions/ziparchive-renameindex.xml
+++ b/reference/zip/functions/ziparchive-renameindex.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-renameindex">
  <refnamediv>
   <refname>ZipArchive::renameIndex</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>boolean</type><methodname>ZipArchive::renameIndex</methodname>
+   <type>bool</type><methodname>ZipArchive::renameIndex</methodname>
    <methodparam><type>integer</type><parameter>index</parameter></methodparam>
    <methodparam><type>string</type><parameter>newname</parameter></methodparam>
   </methodsynopsis>
diff --git a/reference/zip/functions/ziparchive-renamename.xml b/reference/zip/functions/ziparchive-renamename.xml
index dda710f88a..5df25bc7d5 100644
--- a/reference/zip/functions/ziparchive-renamename.xml
+++ b/reference/zip/functions/ziparchive-renamename.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-renamename">
  <refnamediv>
   <refname>ZipArchive::renameName</refname>
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>boolean</type><methodname>ZipArchive::renameName</methodname>
+   <type>bool</type><methodname>ZipArchive::renameName</methodname>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
    <methodparam><type>string</type><parameter>newname</parameter></methodparam>
   </methodsynopsis>
diff --git a/reference/zip/functions/ziparchive-statindex.xml b/reference/zip/functions/ziparchive-statindex.xml
index 147f8853bf..7d799ccdd2 100644
--- a/reference/zip/functions/ziparchive-statindex.xml
+++ b/reference/zip/functions/ziparchive-statindex.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-statindex">
  <refnamediv>
   <refname>ZipArchive::statIndex</refname>
@@ -66,9 +66,7 @@ if ($res === TRUE) {
 ?>
 ]]>
      </programlisting>
-     <para>
-      This example will output :
-     </para>
+      &example.outputs.similar;
      <screen>
 <![CDATA[
 Array
diff --git a/reference/zip/functions/ziparchive-statname.xml b/reference/zip/functions/ziparchive-statname.xml
index 89a2e2f36a..345c53d009 100644
--- a/reference/zip/functions/ziparchive-statname.xml
+++ b/reference/zip/functions/ziparchive-statname.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.ziparchive-statname">
  <refnamediv>
   <refname>ZipArchive::statName</refname>
@@ -63,7 +63,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an array containing the entry details or false on failure.
+   Returns an array containing the entry details or &false; on failure.
   </para>
  </refsect1>
  <refsect1 role="examples">
@@ -84,9 +84,7 @@ if ($res === TRUE) {
 ?>
 ]]>
      </programlisting>
-     <para>
-      This example will output :
-     </para>
+      &example.outputs.similar;
      <screen>
 <![CDATA[
 Array
diff --git a/reference/zip/reference.xml b/reference/zip/reference.xml
index 811e4032e8..eb809e8f08 100644
--- a/reference/zip/reference.xml
+++ b/reference/zip/reference.xml
@@ -1,38 +1,38 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <!-- Purpose: compression -->
 <!-- Membership: pecl -->
 
- <reference id="ref.zip">
-  <title>Zip File Functions</title>
-  <titleabbrev>Zip</titleabbrev>
+<reference id="ref.zip">
+ <title>Zip File Functions</title>
+ <titleabbrev>Zip</titleabbrev>
 
-  <partintro>
-   <section id="zip.intro">
-    &reftitle.intro;
+ <partintro>
+  <section id="zip.intro">
+   &reftitle.intro;
+   <para>
+    This module enables you to transparently read or write ZIP compressed
+    archives and the files inside them.
+   </para>
+  </section>
+
+  <section id="zip.requirements">
+   &reftitle.required;
+   <section>
+    <title>PHP 4 Bundled</title>
     <para>
-     This module enables you to transparently read or write ZIP compressed
-     archives and the files inside them.
+     The initial version is bundled in PHP 4 and is available in PECL
+     as version 1.0, see <ulink url="&url.pecl.package;zip">
+     &url.pecl.package;zip</ulink>. It can only read Zip Archives.
+    </para>
+    <para>
+     This version uses the functions of the <ulink
+     url="&url.zziplib;">ZZIPlib</ulink> library by Guido Draheim.
+     You need ZZIPlib version &gt;= 0.10.6.
     </para>
    </section>
 
-   <section id="zip.requirements">
-    &reftitle.required;
-    <section>
-    <title>PHP4 Bundled</title>
-       <para>
-        The initial version is bundled in PHP 4 and is available in PECL
-        as version 1.0, see <ulink url="&url.pecl.package;zip">
-        &url.pecl.package;zip</ulink>. It can only read Zip Archives.
-       </para>
-       <para>
-        This version uses the functions of the <ulink
-        url="&url.zziplib;">ZZIPlib</ulink> library by Guido Draheim.
-        You need ZZIPlib version &gt;= 0.10.6.
-       </para>
-    </section>
-
-    <section>
+   <section>
     <title>PECL and PHP 5.2 or earlier</title>
     <para>
      The newest version is bundled in PHP 5.2.0 or earlier and
@@ -41,32 +41,32 @@
      when used with PHP 5.1 or ealier and can only read them when used
      with PHP4.
     </para>
-    </section>
    </section>
+  </section>
 
-   &reference.zip.configure;
+  &reference.zip.configure;
 
-   <section id="zip.configuration">
-    &reftitle.runtime;
-    &no.config;
-   </section>
+  <section id="zip.configuration">
+   &reftitle.runtime;
+   &no.config;
+  </section>
 
-   <section id="zip.resources">
-    &reftitle.resources;
-    <para>
-     There are two resource types used in the Zip module. The first one
-     is the Zip directory for the Zip archive, the second Zip Entry for
-     the archive entries.
-    </para>
-   </section>
+  <section id="zip.resources">
+   &reftitle.resources;
+   <para>
+    There are two resource types used in the Zip module. The first one
+    is the Zip directory for the Zip archive, the second Zip Entry for
+    the archive entries.
+   </para>
+  </section>
 
-   &reference.zip.constants;
+  &reference.zip.constants;
 
-   <section id="zip.examples">
-    &reftitle.examples;
-    <example>
-     <title>Create a Zip archive</title>
-     <programlisting role="php">
+  <section id="zip.examples">
+   &reftitle.examples;
+   <example>
+    <title>Create a Zip archive</title>
+    <programlisting role="php">
 <![CDATA[
 <?php
 
@@ -85,11 +85,11 @@ echo "status:" . $zip->status . "\n";
 $zip->close();
 ?>
 ]]>
-     </programlisting>
-    </example>
-    <example>
-     <title>Dump the archive details and listing</title>
-     <programlisting role="php">
+    </programlisting>
+   </example>
+   <example>
+    <title>Dump the archive details and listing</title>
+    <programlisting role="php">
 <![CDATA[
 <?php
 $za = new ZipArchive();
@@ -110,11 +110,11 @@ for ($i=0; $i<$za->numFiles;$i++) {
 echo "numFile:" . $za->numFiles . "\n";
 ?>
 ]]>
-     </programlisting>
-    </example>
-    <example>
-     <title>Zip stream wrapper, read an OpenOffice meta info</title>
-     <programlisting role="php">
+    </programlisting>
+   </example>
+   <example>
+    <title>Zip stream wrapper, read an OpenOffice meta info</title>
+    <programlisting role="php">
 <![CDATA[
 <?php
 $reader = new XMLReader();
@@ -137,18 +137,18 @@ while ($reader->read()) {
 print_r($odt_meta);
 ?>
 ]]>
-     </programlisting>
-    </example>
-    <para>
-     This example uses the old API (PHP 4), it opens a ZIP file
-     archive, reads each file in the archive and prints out its
-     contents. The <filename>test2.zip</filename> archive used in this
-     example is one of the test archives in the ZZIPlib source
-     distribution.
-    </para>
-    <example>
-     <title>Zip Usage Example</title>
-     <programlisting role="php">
+    </programlisting>
+   </example>
+   <para>
+    This example uses the old API (PHP 4), it opens a ZIP file
+    archive, reads each file in the archive and prints out its
+    contents. The <filename>test2.zip</filename> archive used in this
+    example is one of the test archives in the ZZIPlib source
+    distribution.
+   </para>
+   <example>
+    <title>Zip Usage Example</title>
+    <programlisting role="php">
 <![CDATA[
 <?php
 
@@ -177,12 +177,13 @@ if ($zip) {
 }
 ?>
 ]]>
-     </programlisting>
-    </example>
-   </section>
-  </partintro>
+    </programlisting>
+   </example>
+  </section>
+ </partintro>
+
+ &reference.zip.functions;
 
-&reference.zip.functions;
  </reference>
 <!-- Keep this comment at the end of the file
 Local variables: