didou Sun Jun 10 18:32:33 2007 UTC
Modified files:
/phpdoc/en/reference/rar/functions rar-close.xml rar-entry-get.xml
rar-extract.xml rar-getattr.xml
rar-getcrc.xml
rar-getfiletime.xml
rar-gethostos.xml
rar-getmethod.xml
rar-getname.xml
rar-getpackedsize.xml
rar-getunpackedsize.xml
rar-getversion.xml rar-list.xml
rar-open.xml
Log:
ref.rar: switch to new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-close.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-close.xml
diff -u phpdoc/en/reference/rar/functions/rar-close.xml:1.1
phpdoc/en/reference/rar/functions/rar-close.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-close.xml:1.1 Wed Sep 22 15:51:30 2004
+++ phpdoc/en/reference/rar/functions/rar-close.xml Sun Jun 10 18:32:33 2007
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.rar-close">
<refnamediv>
<refname>rar_close</refname>
<refpurpose>Close Rar archive and free all resources</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>rar_close</methodname>
<methodparam><type>resource</type><parameter>rar_file</parameter></methodparam>
@@ -14,10 +15,31 @@
<para>
Close Rar archive and free all allocated resources.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- <function>rar_close</function> returns &false; on error.
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rar_file</parameter></term>
+ <listitem>
+ <para>
+ A Rar file resource, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
</refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-entry-get.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-entry-get.xml
diff -u phpdoc/en/reference/rar/functions/rar-entry-get.xml:1.2
phpdoc/en/reference/rar/functions/rar-entry-get.xml:1.3
--- phpdoc/en/reference/rar/functions/rar-entry-get.xml:1.2 Fri Nov 12
12:38:06 2004
+++ phpdoc/en/reference/rar/functions/rar-entry-get.xml Sun Jun 10 18:32:33 2007
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.rar-entry-get">
<refnamediv>
<refname>rar_entry_get</refname>
<refpurpose>Get entry object from the Rar archive</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>RarEntry</type><methodname>rar_entry_get</methodname>
<methodparam><type>resource</type><parameter>rar_file</parameter></methodparam>
@@ -15,9 +16,45 @@
<para>
Get entry object from the Rar archive.
</para>
- <example>
- <title><function>Rar::</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rar_file</parameter></term>
+ <listitem>
+ <para>
+ A Rar file resource, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>entry_name</parameter></term>
+ <listitem>
+ <para>
+ Path to the entry within the Rar archive.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ <function>rar_get_entry</function> returns entry object or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>rar_entry_get</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -29,12 +66,11 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- <function>rar_get_entry</function> returns entry object or &false; on error.
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-extract.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-extract.xml
diff -u phpdoc/en/reference/rar/functions/rar-extract.xml:1.2
phpdoc/en/reference/rar/functions/rar-extract.xml:1.3
--- phpdoc/en/reference/rar/functions/rar-extract.xml:1.2 Sun Sep 17
21:24:21 2006
+++ phpdoc/en/reference/rar/functions/rar-extract.xml Sun Jun 10 18:32:33 2007
@@ -1,28 +1,67 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.Rar-extract">
<refnamediv>
<refname>Rar::extract</refname>
<refpurpose>Extract entry from the archive</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>bool</type><methodname>Rar::extract</methodname>
- <methodparam><type>string</type><parameter>dir</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>filepath</parameter></methodparam>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>bool</type><methodname>extract</methodname>
+ <methodparam><type>string</type><parameter>dir</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>filepath</parameter></methodparam>
+ </methodsynopsis>
+ </classsynopsis>
<para>
<function>Rar::extract</function> extracts entry's data to the
<parameter>dir</parameter>. It will create new file in the specified
<parameter>dir</parameter> with the name identical to the entry's name.
- If parameter <parameter>filepath</parameter> is specified instead
- <parameter>dir</parameter>, <function>Rar::extract</function> will extract
- entry's data to the specified file.
</para>
- <example>
- <title><function>Rar::extract</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>dir</parameter></term>
+ <listitem>
+ <para>
+ Path to the directory where files should be extracted.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>filepath</parameter></term>
+ <listitem>
+ <para>
+ If parameter <parameter>filepath</parameter> is specified instead
+ <parameter>dir</parameter>, <function>Rar::extract</function> will
extract
+ entry's data to the specified file.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>Rar::extract</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -35,11 +74,11 @@
?>
]]>
- </programlisting>
- </example>
- <example>
- <title>How to extract all files in archive: </title>
- <programlisting role="php">
+ </programlisting>
+ </example>
+ <example>
+ <title>How to extract all files in archive: </title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -58,12 +97,11 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- &return.success;
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-getattr.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-getattr.xml
diff -u phpdoc/en/reference/rar/functions/rar-getattr.xml:1.1
phpdoc/en/reference/rar/functions/rar-getattr.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-getattr.xml:1.1 Tue Sep 28
12:23:27 2004
+++ phpdoc/en/reference/rar/functions/rar-getattr.xml Sun Jun 10 18:32:33 2007
@@ -1,23 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.Rar-getAttr">
<refnamediv>
<refname>Rar::getAttr</refname>
<refpurpose>Get attributes of the entry</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>Rar::getAttr</methodname>
- <void/>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>int</type><methodname>getAttr</methodname>
+ <void/>
+ </methodsynopsis>
+ </classsynopsis>
<para>
<function>Rar::getAttr</function> returns attributes of the archive
entry.
</para>
- <example>
- <title><function>Rar::getAttr</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the attributes or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>Rar::getAttr</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -72,15 +88,21 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- <function>Rar::getAttr</function> returns &false; on error.
+ </programlisting>
+ </example>
</para>
+ </refsect1>
+
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>Rar::getHostOs</function>.
+ <simplelist>
+ <member><xref linkend="function.Rar-getHostOs" /></member>
+ </simplelist>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-getcrc.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-getcrc.xml
diff -u phpdoc/en/reference/rar/functions/rar-getcrc.xml:1.1
phpdoc/en/reference/rar/functions/rar-getcrc.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-getcrc.xml:1.1 Tue Sep 28
12:23:27 2004
+++ phpdoc/en/reference/rar/functions/rar-getcrc.xml Sun Jun 10 18:32:33 2007
@@ -1,33 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.Rar-getCrc">
<refnamediv>
<refname>Rar::getCrc</refname>
<refpurpose>Get CRC of the entry</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>Rar::getCrc</methodname>
- <void/>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>int</type><methodname>getCrc</methodname>
+ <void/>
+ </methodsynopsis>
+ </classsynopsis>
<para>
<function>Rar::getCrc</function> returns CRC of the archive entry.
</para>
- <example>
- <title><function>Rar::getCrc</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
+ </refsect1>
-?>
-]]>
- </programlisting>
- </example>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- <function>Rar::getCrc</function> returns &false; on error.
+ Returns the CRC of the archive entry or &false; on error.
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-getfiletime.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-getfiletime.xml
diff -u phpdoc/en/reference/rar/functions/rar-getfiletime.xml:1.1
phpdoc/en/reference/rar/functions/rar-getfiletime.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-getfiletime.xml:1.1 Tue Sep 28
12:23:27 2004
+++ phpdoc/en/reference/rar/functions/rar-getfiletime.xml Sun Jun 10
18:32:33 2007
@@ -1,34 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.Rar-getFileTime">
<refnamediv>
<refname>Rar::getFileTime</refname>
<refpurpose>Get entry last modification time</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>Rar::getFileTime</methodname>
- <void/>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>string</type><methodname>getFileTime</methodname>
+ <void/>
+ </methodsynopsis>
+ </classsynopsis>
<para>
- <function>Rar::getFileTime</function> returns entry last modification
- time as string in format YYYY-MM-DD HH:II:SS.
+ Gets entry last modification time.
</para>
- <example>
- <title><function>Rar::</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
+ </refsect1>
-?>
-]]>
- </programlisting>
- </example>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- <function>Rar::getFileTime</function> returns &false; on error.
+ Returns entry last modification time as string in format
+ <literal>YYYY-MM-DD HH:II:SS</literal>, or &false; on error.
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-gethostos.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-gethostos.xml
diff -u phpdoc/en/reference/rar/functions/rar-gethostos.xml:1.1
phpdoc/en/reference/rar/functions/rar-gethostos.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-gethostos.xml:1.1 Tue Sep 28
12:23:27 2004
+++ phpdoc/en/reference/rar/functions/rar-gethostos.xml Sun Jun 10 18:32:33 2007
@@ -1,23 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.Rar-getHostOs">
<refnamediv>
<refname>Rar::getHostOs</refname>
<refpurpose>Get entry host OS</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>Rar::getHostOs</methodname>
- <void/>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>int</type><methodname>getHostOs</methodname>
+ <void/>
+ </methodsynopsis>
+ </classsynopsis>
<para>
<function>Rar::getHostOs</function> return code of the host OS of the
archive entry.
</para>
- <example>
- <title><function>Rar::getHostOs</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the code of the host OS, or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>Rar::getHostOs</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -48,12 +64,11 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- <function>Rar::getHostOs</function> returns &false; on error.
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-getmethod.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-getmethod.xml
diff -u phpdoc/en/reference/rar/functions/rar-getmethod.xml:1.1
phpdoc/en/reference/rar/functions/rar-getmethod.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-getmethod.xml:1.1 Tue Sep 28
12:23:27 2004
+++ phpdoc/en/reference/rar/functions/rar-getmethod.xml Sun Jun 10 18:32:33 2007
@@ -1,23 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.Rar-getMethod">
<refnamediv>
<refname>Rar::getMethod</refname>
<refpurpose>Get pack method of the entry</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>Rar::getMethod</methodname>
- <void/>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>int</type><methodname>getMethod</methodname>
+ <void/>
+ </methodsynopsis>
+ </classsynopsis>
<para>
<function>Rar::getMethod</function> returns number of the method used when
adding
current archive entry.
</para>
- <example>
- <title><function>Rar::getMethod</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the method number or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>Rar::getMethod</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -29,12 +45,11 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- <function>Rar::getMethod</function> returns &false; on error.
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-getname.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-getname.xml
diff -u phpdoc/en/reference/rar/functions/rar-getname.xml:1.1
phpdoc/en/reference/rar/functions/rar-getname.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-getname.xml:1.1 Tue Sep 28
12:23:27 2004
+++ phpdoc/en/reference/rar/functions/rar-getname.xml Sun Jun 10 18:32:33 2007
@@ -1,22 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.Rar-getName">
<refnamediv>
<refname>Rar::getName</refname>
<refpurpose>Get name of the entry</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>Rar::getName</methodname>
- <void/>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>string</type><methodname>getName</methodname>
+ <void/>
+ </methodsynopsis>
+ </classsynopsis>
<para>
<function>Rar::getName</function> returns full name of the archive entry.
</para>
- <example>
- <title><function>Rar::getName</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the entry name as a string, or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>Rar::getName</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -28,12 +44,11 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- <function>Rar::getName</function> returns &false; on error.
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-getpackedsize.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-getpackedsize.xml
diff -u phpdoc/en/reference/rar/functions/rar-getpackedsize.xml:1.1
phpdoc/en/reference/rar/functions/rar-getpackedsize.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-getpackedsize.xml:1.1 Tue Sep 28
12:23:27 2004
+++ phpdoc/en/reference/rar/functions/rar-getpackedsize.xml Sun Jun 10
18:32:33 2007
@@ -1,22 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.Rar-getPackedSize">
<refnamediv>
<refname>Rar::getPackedSize</refname>
<refpurpose>Get packed size of the entry</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>Rar::getPackedSize</methodname>
- <void/>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>int</type><methodname>getPackedSize</methodname>
+ <void/>
+ </methodsynopsis>
+ </classsynopsis>
<para>
Get packed size of the archive entry.
</para>
- <example>
- <title><function>Rar::</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the packed size, or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>Rar::getPackedSize</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -28,12 +44,11 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- <function>Rar::getPackedSize</function> returns &false; on error.
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-getunpackedsize.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-getunpackedsize.xml
diff -u phpdoc/en/reference/rar/functions/rar-getunpackedsize.xml:1.1
phpdoc/en/reference/rar/functions/rar-getunpackedsize.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-getunpackedsize.xml:1.1 Tue Sep
28 12:23:27 2004
+++ phpdoc/en/reference/rar/functions/rar-getunpackedsize.xml Sun Jun 10
18:32:33 2007
@@ -1,22 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.Rar-getUnpackedSize">
<refnamediv>
<refname>Rar::getUnpackedSize</refname>
<refpurpose>Get unpacked size of the entry</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>Rar::getUnpackedSize</methodname>
- <void/>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>int</type><methodname>getUnpackedSize</methodname>
+ <void/>
+ </methodsynopsis>
+ </classsynopsis>
<para>
Get unpacked size of the archive entry.
</para>
- <example>
- <title><function>Rar::getUnpackedSize</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the unpacked size, or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ <example>
+ <title><function>Rar::getUnpackedSize</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -28,12 +44,11 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- <function>Rar::getUnpackedSize</function> returns &false; on error.
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-getversion.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-getversion.xml
diff -u phpdoc/en/reference/rar/functions/rar-getversion.xml:1.1
phpdoc/en/reference/rar/functions/rar-getversion.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-getversion.xml:1.1 Tue Sep 28
12:23:27 2004
+++ phpdoc/en/reference/rar/functions/rar-getversion.xml Sun Jun 10
18:32:33 2007
@@ -1,22 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.Rar-getVersion">
<refnamediv>
<refname>Rar::getVersion</refname>
<refpurpose>Get version of the archiver used to add the entry</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>Rar::getVersion</methodname>
- <void/>
- </methodsynopsis>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <classsynopsis>
+ <ooclass><classname>Rar</classname></ooclass>
+ <methodsynopsis>
+ <type>int</type><methodname>getVersion</methodname>
+ <void/>
+ </methodsynopsis>
+ </classsynopsis>
<para>
Get version of the archiver used to add the archive entry.
</para>
- <example>
- <title><function>Rar::getVersion</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the version or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>Rar::getVersion</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -28,12 +44,11 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- <function>Rar::getVersion</function> returns &false; on error.
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-list.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-list.xml
diff -u phpdoc/en/reference/rar/functions/rar-list.xml:1.1
phpdoc/en/reference/rar/functions/rar-list.xml:1.2
--- phpdoc/en/reference/rar/functions/rar-list.xml:1.1 Wed Sep 22 15:51:30 2004
+++ phpdoc/en/reference/rar/functions/rar-list.xml Sun Jun 10 18:32:33 2007
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.rar-list">
<refnamediv>
<refname>rar_list</refname>
<refpurpose>Get entries list from the Rar archive</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>array</type><methodname>rar_list</methodname>
<methodparam><type>resource</type><parameter>rar_file</parameter></methodparam>
@@ -14,9 +15,37 @@
<para>
Get entries list from the Rar archive.
</para>
- <example>
- <title><function>Rar::</function> example</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rar_file</parameter></term>
+ <listitem>
+ <para>
+ A Rar file resource, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ <function>rar_list</function> returns array of entries or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>rar_list</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -28,12 +57,11 @@
?>
]]>
- </programlisting>
- </example>
- <para>
- <function>rar_list</function> returns array of entries or &false; on error.
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/rar/functions/rar-open.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/rar/functions/rar-open.xml
diff -u phpdoc/en/reference/rar/functions/rar-open.xml:1.2
phpdoc/en/reference/rar/functions/rar-open.xml:1.3
--- phpdoc/en/reference/rar/functions/rar-open.xml:1.2 Thu Nov 11 14:54:24 2004
+++ phpdoc/en/reference/rar/functions/rar-open.xml Sun Jun 10 18:32:33 2007
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.rar-open">
<refnamediv>
<refname>rar_open</refname>
<refpurpose>Open Rar archive</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>rar_open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
@@ -15,10 +16,39 @@
<para>
Open specified Rar archive and return Rar file resource.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Path to the Rar archive.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>password</parameter></term>
+ <listitem>
+ <para>
+ A plain password, if needed.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
<function>rar_open</function> returns Rar file resource or &false; on error.
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
