Fix protos

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@321911 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2012-01-08 07:59:53 +00:00
parent 46807ff2a6
commit 60ec244618
37 changed files with 106 additions and 62 deletions

View file

@ -10,9 +10,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntHash::add</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>value</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntHash::add</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
This method adds a new entry to the hash, and returns whether the entry was

View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>QuickHashIntHash::__construct</methodname>
<methodparam><type>integer</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This constructor creates a new QuickHashIntHash. The size is the amount of

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntHash::delete</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntHash::delete</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This method deletes an entry from the hash, and returns whether the entry was

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntHash::exists</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntHash::exists</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This method checks whether an entry with the provided key exists in the

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>integer</type><methodname>QuickHashIntHash::get</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>int</type><methodname>QuickHashIntHash::get</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This method retrieves a value from the hash by its key.

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>integer</type><methodname>QuickHashIntHash::getSize</methodname><void/>
<modifier>public</modifier> <type>int</type><methodname>QuickHashIntHash::getSize</methodname><void/>
</methodsynopsis>
<para>
Returns the number of elements in the hash.

View file

@ -12,7 +12,7 @@
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashIntHash</type><methodname>QuickHashIntHash::loadFromFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This factory method creates a new hash from a definition file on disk. The

View file

@ -12,7 +12,7 @@
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashIntHash</type><methodname>QuickHashIntHash::loadFromString</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This factory method creates a new hash from a definition in a string. The

View file

@ -11,9 +11,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntHash::set</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<methodparam><type>integer</type><parameter>value</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntHash::set</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
This method tries to update an entry with a new value. In case the entry

View file

@ -10,9 +10,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntHash::update</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<methodparam><type>integer</type><parameter>value</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntHash::update</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
This method updates an entry with a new value, and returns whether the entry was

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntSet::add</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntSet::add</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This method adds a new entry to the set, and returns whether the entry was

View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>QuickHashIntSet::__construct</methodname>
<methodparam><type>integer</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This constructor creates a new QuickHashIntSet. The size is the amount of

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntSet::delete</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntSet::delete</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This method deletes an entry from the set, and returns whether the entry was

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntSet::exists</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntSet::exists</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This method checks whether an entry with the provided key exists in the

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier><type>integer</type><methodname>QuickHashIntSet::getSize</methodname><void/>
<modifier>public</modifier><type>int</type><methodname>QuickHashIntSet::getSize</methodname><void/>
</methodsynopsis>
<para>
Returns the number of elements in the set.

View file

@ -12,8 +12,8 @@
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashIntSet</type><methodname>QuickHashIntSet::loadFromFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This factory method creates a new set from a definition file on disk. The

View file

@ -12,8 +12,8 @@
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashIntSet</type><methodname>QuickHashIntSet::loadFromString</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This factory method creates a new set from a definition in a string. The

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntStringHash::add</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntStringHash::add</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>QuickHashIntStringHash::__construct</methodname>
<methodparam><type>integer</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This constructor creates a new QuickHashIntStringHash. The size is the amount of

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntStringHash::delete</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntStringHash::delete</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This method deletes an entry from the hash, and returns whether the entry was

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntStringHash::exists</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntStringHash::exists</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This method checks whether an entry with the provided key exists in the

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>integer</type><methodname>QuickHashIntStringHash::get</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>mixed</type><methodname>QuickHashIntStringHash::get</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This method retrieves a value from the hash by its key.

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>integer</type><methodname>QuickHashIntStringHash::getSize</methodname><void/>
<modifier>public</modifier> <type>int</type><methodname>QuickHashIntStringHash::getSize</methodname><void/>
</methodsynopsis>
<para>
Returns the number of elements in the hash.

View file

@ -12,7 +12,8 @@
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashIntStringHash</type><methodname>QuickHashIntStringHash::loadFromFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>size</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This factory method creates a new hash from a definition file on disk. The
@ -75,6 +76,16 @@ key/value 2 (key = 3, string index = 4 ("NINE")):
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The amount of bucket lists to configure. The number you pass in will be
automatically rounded up to the next power of two. It is also
automatically limited from 4 to 4194304.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>

View file

@ -12,7 +12,8 @@
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashIntStringHash</type><methodname>QuickHashIntStringHash::loadFromString</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>size</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This factory method creates a new hash from a definition in a string. The
@ -32,6 +33,16 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The amount of bucket lists to configure. The number you pass in will be
automatically rounded up to the next power of two. It is also
automatically limited from 4 to 4194304.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>

View file

@ -11,8 +11,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntStringHash::set</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>int</type><methodname>QuickHashIntStringHash::set</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashIntStringHash::update</methodname>
<methodparam><type>integer</type><parameter>key</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntStringHash::update</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashStringIntHash::add</methodname>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashStringIntHash::add</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>

View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>QuickHashStringIntHash::__construct</methodname>
<methodparam><type>integer</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This constructor creates a new QuickHashStringIntHash. The size is the amount of

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashStringIntHash::delete</methodname>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashStringIntHash::delete</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashStringIntHash::exists</methodname>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashStringIntHash::exists</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>integer</type><methodname>QuickHashStringIntHash::get</methodname>
<modifier>public</modifier> <type>mixed</type><methodname>QuickHashStringIntHash::get</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>integer</type><methodname>QuickHashStringIntHash::getSize</methodname><void/>
<modifier>public</modifier> <type>int</type><methodname>QuickHashStringIntHash::getSize</methodname><void/>
</methodsynopsis>
<para>
Returns the number of elements in the hash.

View file

@ -12,7 +12,8 @@
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashStringIntHash</type><methodname>QuickHashStringIntHash::loadFromFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>size</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This factory method creates a new hash from a definition file on disk. The
@ -87,6 +88,16 @@ bucket lists:
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The amount of bucket lists to configure. The number you pass in will be
automatically rounded up to the next power of two. It is also
automatically limited from 4 to 4194304.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>

View file

@ -12,7 +12,8 @@
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashStringIntHash</type><methodname>QuickHashStringIntHash::loadFromString</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>size</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This factory method creates a new hash from a definition in a string. The
@ -32,6 +33,16 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The amount of bucket lists to configure. The number you pass in will be
automatically rounded up to the next power of two. It is also
automatically limited from 4 to 4194304.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>

View file

@ -11,7 +11,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashStringIntHash::set</methodname>
<modifier>public</modifier> <type>int</type><methodname>QuickHashStringIntHash::set</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>

View file

@ -10,9 +10,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>boolean</type><methodname>QuickHashStringIntHash::update</methodname>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashStringIntHash::update</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>integer</type><parameter>value</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
This method updates an entry with a new value, and returns whether the entry was