Fix protos

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308250 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2011-02-11 11:14:39 +00:00
parent 7e8e878bc0
commit 81ba8c58c0
21 changed files with 55 additions and 22 deletions

View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>OAuth::setCAPath</methodname>
<methodparam><type>string</type><parameter>ca_path</parameter></methodparam>
<methodparam><type>string</type><parameter>ca_info</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>ca_path</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>ca_info</parameter></methodparam>
</methodsynopsis>
<para>
Sets the Certificate Authority (<acronym>CA</acronym>), both for path

View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>OAuth::setRequestEngine</methodname>
<methodparam><type>string</type><parameter>reqengine</parameter></methodparam>
<methodparam><type>int</type><parameter>reqengine</parameter></methodparam>
</methodsynopsis>
<para>
Sets the Request Engine, that will be sending the HTTP requests.

View file

@ -10,8 +10,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>OAuthProvider::reportProblem</methodname>
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>OAuthProvider::reportProblem</methodname>
<methodparam><type>string</type><parameter>oauthexception</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>send_headers</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
Pass in a problem as an <classname>OAuthException</classname>, with possible problems listed

View file

@ -11,7 +11,7 @@
<methodsynopsis>
<type>object</type><methodname>PharData::compress</methodname>
<methodparam><type>int</type><parameter>compression</parameter></methodparam>
<methodparam><type>string</type><parameter>extension</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>PharData::delMetadata</methodname>
<type>bool</type><methodname>PharData::delMetadata</methodname>
<void/>
</methodsynopsis>
&phar.write;

View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>PharData::delete</methodname>
<type>bool</type><methodname>PharData::delete</methodname>
<methodparam><type>string</type><parameter>entry</parameter></methodparam>
</methodsynopsis>

View file

@ -9,10 +9,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>PharData::extractTo</methodname>
<type>bool</type><methodname>PharData::extractTo</methodname>
<methodparam><type>string</type><parameter>pathto</parameter></methodparam>
<methodparam choice="opt"><type>string|array</type><parameter>files</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>

View file

@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>PharData::setDefaultStub</methodname>
<type>bool</type><methodname>PharData::setDefaultStub</methodname>
<methodparam choice="opt"><type>string</type><parameter>index</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>webindex</parameter></methodparam>
</methodsynopsis>
@ -47,7 +47,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
&return.success;
</para>
</refsect1>

View file

@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>PharData::setStub</methodname>
<type>bool</type><methodname>PharData::setStub</methodname>
<methodparam><type>string</type><parameter>stub</parameter></methodparam>
</methodsynopsis>
@ -40,7 +40,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
&return.success;
</para>
</refsect1>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>RarArchive::__toString</methodname>
<modifier>public</modifier> <type>string</type><methodname>RarArchive::__toString</methodname>
<void />
</methodsynopsis>
<para>

View file

@ -14,6 +14,7 @@
<methodparam><type>string</type><parameter>index</parameter></methodparam>
<methodparam><type>array</type><parameter>attributes</parameter></methodparam>
<methodparam><type>array</type><parameter>values</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>mva</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Instantly updates given attribute values in given documents.

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>integer</type><methodname>ssdeep_fuzzy_compare</methodname>
<type>int</type><methodname>ssdeep_fuzzy_compare</methodname>
<methodparam><type>string</type><parameter>signature1</parameter></methodparam>
<methodparam><type>string</type><parameter>signature2</parameter></methodparam>
</methodsynopsis>

View file

@ -14,6 +14,7 @@
<methodparam><type>string</type><parameter>frompath</parameter></methodparam>
<methodparam><type>string</type><parameter>topath</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>working_copy</parameter><initializer>true</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>revision_no</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
Export the contents of either a working copy or repository into a

View file

@ -12,6 +12,7 @@
<methodparam><type>string</type><parameter>repos_url</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>revision_no</parameter><initializer>SVN_REVISION_HEAD</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>recurse</parameter><initializer>false</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>peg</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
This function queries the repository URL and returns a list of

View file

@ -12,6 +12,7 @@
<methodsynopsis>
<type>bool</type><methodname>svn_mkdir</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>log_message</parameter></methodparam>
</methodsynopsis>
<para>
Creates a directory in a working copy or repository.

View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>wincache_rplist_fileinfo</methodname>
<void/>
<methodparam choice="opt"><type>bool</type><parameter>summaryonly</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Retrieves information about cached mappings between relative file paths

View file

@ -11,10 +11,16 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>wincache_ucache_add</methodname>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>ttl</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>wincache_ucache_add</methodname>
<methodparam><type>array</type><parameter>values</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>unused</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>ttl</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Adds a variable in user cache, only if this variable doesn't already exist in the cache.
The added variable remains in the user cache unless its time to live expires or it is
@ -49,6 +55,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
Associative array of keys and values.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ttl</parameter></term>
<listitem>

View file

@ -10,10 +10,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>wincache_ucache_cas</methodname>
<type>bool</type><methodname>wincache_ucache_cas</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>long</type><parameter>old_value</parameter></methodparam>
<methodparam><type>long</type><parameter>new_value</parameter></methodparam>
<methodparam><type>int</type><parameter>old_value</parameter></methodparam>
<methodparam><type>int</type><parameter>new_value</parameter></methodparam>
</methodsynopsis>
<para>
Compares the variable associated with the <parameter>key</parameter> with <parameter>old_value</parameter>

View file

@ -12,7 +12,7 @@
<methodsynopsis>
<type>mixed</type><methodname>wincache_ucache_dec</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>long</type><parameter>dec_by</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>dec_by</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter role="reference">success</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -12,7 +12,7 @@
<methodsynopsis>
<type>mixed</type><methodname>wincache_ucache_inc</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>long</type><parameter>inc_by</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>inc_by</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter role="reference">success</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -15,6 +15,12 @@
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>ttl</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>wincache_ucache_set</methodname>
<methodparam><type>array</type><parameter>values</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>unused</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>ttl</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Adds a variable in user cache. Overwrites a variable if it already exists in the cache.
The added or updated variable remains in the user cache unless its time to live expires or it is
@ -50,6 +56,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
Associative array of keys and values.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ttl</parameter></term>
<listitem>