[DOC-CVS] [doc-en] master: quickhash : fix XML by converting para to simpara tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-19T03:18:08Z
Commit: https://github.com/php/doc-en/commit/bfe06c36ec1c0a37909704b292a204195b0bc14f
Raw diff: https://github.com/php/doc-en/commit/bfe06c36ec1c0a37909704b292a204195b0bc14f.diff
quickhash : fix XML by converting para to simpara tags via script
Changed paths:
M reference/quickhash/book.xml
M reference/quickhash/quickhashinthash.xml
M reference/quickhash/quickhashinthash/add.xml
M reference/quickhash/quickhashinthash/construct.xml
M reference/quickhash/quickhashinthash/delete.xml
M reference/quickhash/quickhashinthash/exists.xml
M reference/quickhash/quickhashinthash/get.xml
M reference/quickhash/quickhashinthash/getsize.xml
M reference/quickhash/quickhashinthash/loadfromfile.xml
M reference/quickhash/quickhashinthash/loadfromstring.xml
M reference/quickhash/quickhashinthash/savetofile.xml
M reference/quickhash/quickhashinthash/savetostring.xml
M reference/quickhash/quickhashinthash/set.xml
M reference/quickhash/quickhashinthash/update.xml
M reference/quickhash/quickhashintset.xml
M reference/quickhash/quickhashintset/add.xml
M reference/quickhash/quickhashintset/construct.xml
M reference/quickhash/quickhashintset/delete.xml
M reference/quickhash/quickhashintset/exists.xml
M reference/quickhash/quickhashintset/getsize.xml
M reference/quickhash/quickhashintset/loadfromfile.xml
M reference/quickhash/quickhashintset/loadfromstring.xml
M reference/quickhash/quickhashintset/savetofile.xml
M reference/quickhash/quickhashintset/savetostring.xml
M reference/quickhash/quickhashintstringhash.xml
M reference/quickhash/quickhashintstringhash/add.xml
M reference/quickhash/quickhashintstringhash/construct.xml
M reference/quickhash/quickhashintstringhash/delete.xml
M reference/quickhash/quickhashintstringhash/exists.xml
M reference/quickhash/quickhashintstringhash/get.xml
M reference/quickhash/quickhashintstringhash/getsize.xml
M reference/quickhash/quickhashintstringhash/loadfromfile.xml
M reference/quickhash/quickhashintstringhash/loadfromstring.xml
M reference/quickhash/quickhashintstringhash/savetofile.xml
M reference/quickhash/quickhashintstringhash/savetostring.xml
M reference/quickhash/quickhashintstringhash/set.xml
M reference/quickhash/quickhashintstringhash/update.xml
M reference/quickhash/quickhashstringinthash.xml
M reference/quickhash/quickhashstringinthash/add.xml
M reference/quickhash/quickhashstringinthash/construct.xml
M reference/quickhash/quickhashstringinthash/delete.xml
M reference/quickhash/quickhashstringinthash/exists.xml
M reference/quickhash/quickhashstringinthash/get.xml
M reference/quickhash/quickhashstringinthash/getsize.xml
M reference/quickhash/quickhashstringinthash/loadfromfile.xml
M reference/quickhash/quickhashstringinthash/loadfromstring.xml
M reference/quickhash/quickhashstringinthash/savetofile.xml
M reference/quickhash/quickhashstringinthash/savetostring.xml
M reference/quickhash/quickhashstringinthash/set.xml
M reference/quickhash/quickhashstringinthash/update.xml
M reference/quickhash/setup.xml
Diff:
diff --git a/reference/quickhash/book.xml b/reference/quickhash/book.xml
index 902c46ef863f..06d1b87a66b8 100644
--- a/reference/quickhash/book.xml
+++ b/reference/quickhash/book.xml
@@ -1,17 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<book xml:id="book.quickhash" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.quickhash">
<?phpdoc extension-membership="pecl" ?>
<title>Quickhash</title>
<titleabbrev>Quickhash</titleabbrev>
<preface xml:id="intro.quickhash">
&reftitle.intro;
- <para>
+ <simpara>
The quickhash extension contains a set of specific strongly-typed classes
to deal with specific set and hash implementations.
- </para>
+ </simpara>
</preface>
&reference.quickhash.setup;
@@ -22,7 +21,6 @@
&reference.quickhash.quickhashstringinthash;
&reference.quickhash.quickhashintstringhash;
</book>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash.xml b/reference/quickhash/quickhashinthash.xml
index 0209fff8cfe1..e11d18640de4 100644
--- a/reference/quickhash/quickhashinthash.xml
+++ b/reference/quickhash/quickhashinthash.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.quickhashinthash" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.quickhashinthash" role="class">
<title>The QuickHashIntHash class</title>
<titleabbrev>QuickHashIntHash</titleabbrev>
@@ -11,16 +10,16 @@
<!-- {{{ QuickHashIntHash intro -->
<section xml:id="quickhashinthash.intro">
&reftitle.intro;
- <para>
+ <simpara>
This class wraps around a hash containing integer numbers, where the
values are also integer numbers. Hashes are also available as
implementation of the <interfacename>ArrayAccess</interfacename> interface.
- </para>
- <para>
+ </simpara>
+ <simpara>
Hashes can also be iterated over with <link linkend="control-structures.foreach"><literal>foreach</literal></link> as the <interfacename>Iterator</interfacename> interface is
implemented as well. The order of which elements are returned in is not
guaranteed.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -71,7 +70,7 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashinthash')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashinthash')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
@@ -85,42 +84,42 @@
<varlistentry xml:id="quickhashinthash.constants.check-for-dupes">
<term><constant>QuickHashIntHash::CHECK_FOR_DUPES</constant></term>
<listitem>
- <para>If enabled, adding duplicate elements to a set (through either <methodname>QuickHashIntHash::add</methodname> or
+ <simpara>If enabled, adding duplicate elements to a set (through either <methodname>QuickHashIntHash::add</methodname> or
<methodname>QuickHashIntHash::loadFromFile</methodname>) will result in those elements to be dropped from the
- set. This will take up extra time, so only used when it is required.</para>
+ set. This will take up extra time, so only used when it is required.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashinthash.constants.do-not-use-zend-alloc">
<term><constant>QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC</constant></term>
<listitem>
- <para>Disables the use of PHP's internal memory manager for internal
+ <simpara>Disables the use of PHP's internal memory manager for internal
set structures. With this option enabled, internal allocations will not
- count towards the <link linkend="ini.memory-limit">memory_limit</link> settings.</para>
+ count towards the <link linkend="ini.memory-limit">memory_limit</link> settings.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashinthash.constants.hasher-no-hash">
<term><constant>QuickHashIntHash::HASHER_NO_HASH</constant></term>
<listitem>
- <para>Selects to not use a hashing function, but merely use a modulo to
+ <simpara>Selects to not use a hashing function, but merely use a modulo to
find the bucket list index. This is not faster than normal hashing, and
- gives more collisions.</para>
+ gives more collisions.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashinthash.constants.hasher-jenkins1">
<term><constant>QuickHashIntHash::HASHER_JENKINS1</constant></term>
<listitem>
- <para>This is the default hashing function to turn the integer hashes
- into bucket list indexes.</para>
+ <simpara>This is the default hashing function to turn the integer hashes
+ into bucket list indexes.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashinthash.constants.hasher-jenkins2">
<term><constant>QuickHashIntHash::HASHER_JENKINS2</constant></term>
<listitem>
- <para>Selects a variant hashing algorithm.</para>
+ <simpara>Selects a variant hashing algorithm.</simpara>
</listitem>
</varlistentry>
@@ -134,7 +133,6 @@
&reference.quickhash.entities.quickhashinthash;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/add.xml b/reference/quickhash/quickhashinthash/add.xml
index f1327626783a..d85702ec4475 100644
--- a/reference/quickhash/quickhashinthash/add.xml
+++ b/reference/quickhash/quickhashinthash/add.xml
@@ -13,11 +13,11 @@
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method adds a new entry to the hash, and returns whether the entry was
added. Entries are by default always added unless
<constant>QuickHashIntHash::CHECK_FOR_DUPES</constant> has been passed when the hash was created.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,18 +26,18 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to add.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <para>
+ <simpara>
The optional value of the entry to add. If no value is specified,
<literal>1</literal> will be used.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,9 +45,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was added, and &false; if the entry was not added.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/construct.xml b/reference/quickhash/quickhashinthash/construct.xml
index c6902e278526..7ba6b1ce9ec2 100644
--- a/reference/quickhash/quickhashinthash/construct.xml
+++ b/reference/quickhash/quickhashinthash/construct.xml
@@ -13,11 +13,11 @@
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This constructor creates a new <classname>QuickHashIntHash</classname>. The size is the amount of
bucket lists to create. The more lists there are, the less collisions you
will have. Options are also supported.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,17 +26,17 @@
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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 <literal>64</literal> to <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The options that you can pass in are: <constant>QuickHashIntHash::CHECK_FOR_DUPES</constant>,
which makes sure no duplicate entries are added to the hash;
<constant>QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC</constant> to not use PHP's internal memory
@@ -44,7 +44,7 @@
<constant>QuickHashIntHash::HASHER_JENKINS1</constant> or <constant>QuickHashIntHash::HASHER_JENKINS2</constant>.
These last three configure which hashing algorithm to use. All options
can be combined using bitmasks.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,9 +52,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashIntHash</classname> object.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/delete.xml b/reference/quickhash/quickhashinthash/delete.xml
index 70d3dfd451d7..6f6f7c0c9b75 100644
--- a/reference/quickhash/quickhashinthash/delete.xml
+++ b/reference/quickhash/quickhashinthash/delete.xml
@@ -12,16 +12,16 @@
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntHash::delete</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method deletes an entry from the hash, and returns whether the entry was
deleted or not. Associated memory structures will not be freed immediately,
but rather when the hash itself is freed.
- </para>
- <para>
+ </simpara>
+ <simpara>
Elements can not be deleted when the hash is used in an iterator. The
method will not throw an exception, but simply return &false; like would
happen with any other deletion failure.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,9 +30,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to delete.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +40,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was deleted, and &false; if the entry was not deleted.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/exists.xml b/reference/quickhash/quickhashinthash/exists.xml
index aa738e7aebfd..9feabc65a1f8 100644
--- a/reference/quickhash/quickhashinthash/exists.xml
+++ b/reference/quickhash/quickhashinthash/exists.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntHash::exists</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method checks whether an entry with the provided key exists in the
hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to check for whether it exists in the hash.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,10 +34,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; when the entry was found, or &false; when the entry is not
found.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/get.xml b/reference/quickhash/quickhashinthash/get.xml
index 1473a7a48db4..2b6f23566858 100644
--- a/reference/quickhash/quickhashinthash/get.xml
+++ b/reference/quickhash/quickhashinthash/get.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>int</type><methodname>QuickHashIntHash::get</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method retrieves a value from the hash by its key.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to retrieve.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
The value if the key exists, or &null; if the key wasn't part of the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/getsize.xml b/reference/quickhash/quickhashinthash/getsize.xml
index a2fdbec19f02..400939a74b46 100644
--- a/reference/quickhash/quickhashinthash/getsize.xml
+++ b/reference/quickhash/quickhashinthash/getsize.xml
@@ -11,9 +11,9 @@
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>QuickHashIntHash::getSize</methodname><void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns the number of elements in the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
The number of elements in the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/loadfromfile.xml b/reference/quickhash/quickhashinthash/loadfromfile.xml
index eef548f39ed1..2d5c58f8f0fb 100644
--- a/reference/quickhash/quickhashinthash/loadfromfile.xml
+++ b/reference/quickhash/quickhashinthash/loadfromfile.xml
@@ -13,7 +13,7 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This factory method creates a new hash from a definition file on disk. The
file format consists of a signature <literal>'QH\0x11\0'</literal>, the number of elements as
a 32 bit signed integer in system Endianness, followed by 32 bit signed
@@ -21,7 +21,7 @@
runs on uses. For each hash element there are two 32 bit signed integers
stored. The first of each element is the key, and the second is the value
belonging to the key. An example could be:
- </para>
+ </simpara>
<example>
<title>QuickHash IntHash file format</title>
<screen><![CDATA[00000000 51 48 11 00 02 00 00 00 01 00 00 00 01 00 00 00 |QH..............|
@@ -56,20 +56,20 @@ key/value 2 (key = 3, value = 9)
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
The filename of the file to read the hash from.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The same options that the class' constructor takes; except that the size
option is ignored. It is automatically calculated to be the same as the
number of entries in the hash, rounded up to the nearest power of two
with a maximum limit of <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -77,9 +77,9 @@ key/value 2 (key = 3, value = 9)
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashIntHash</classname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/loadfromstring.xml b/reference/quickhash/quickhashinthash/loadfromstring.xml
index f359d1b249cd..bc20e9cc3f12 100644
--- a/reference/quickhash/quickhashinthash/loadfromstring.xml
+++ b/reference/quickhash/quickhashinthash/loadfromstring.xml
@@ -13,13 +13,13 @@
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This factory method creates a new hash from a definition in a string. The
file format consists of 32 bit signed integers packed together in the
Endianness that the system that the code runs on uses. For each element
there are two 32 bit signed integers stored. The first of each element is
the key, and the second is the value belonging to the key.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,20 +28,20 @@
<varlistentry>
<term><parameter>contents</parameter></term>
<listitem>
- <para>
+ <simpara>
The string containing a serialized format of the hash.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The same options that the class' constructor takes; except that the size
option is ignored. It is automatically calculated to be the same as the
number of entries in the hash, rounded up to the nearest power of two
with a maximum limit of <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -49,9 +49,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashIntHash</classname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/savetofile.xml b/reference/quickhash/quickhashinthash/savetofile.xml
index edc596f1f186..fb0d7ac04b13 100644
--- a/reference/quickhash/quickhashinthash/savetofile.xml
+++ b/reference/quickhash/quickhashinthash/savetofile.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>void</type><methodname>QuickHashIntHash::saveToFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method stores an existing hash to a file on disk, in the same format
that <methodname>QuickHashIntHash::loadFromFile</methodname> can read.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
The filename of the file to store the hash in.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/savetostring.xml b/reference/quickhash/quickhashinthash/savetostring.xml
index c9dd7f93b69a..554657cb7107 100644
--- a/reference/quickhash/quickhashinthash/savetostring.xml
+++ b/reference/quickhash/quickhashinthash/savetostring.xml
@@ -11,10 +11,10 @@
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>QuickHashIntHash::saveToString</methodname><void/>
</methodsynopsis>
- <para>
+ <simpara>
This method returns a serialized version of the hash in the same format that
<methodname>QuickHashIntHash::loadFromString</methodname> can read.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,11 +24,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
This method returns a string containing a serialized format of the hash.
Each element is stored as a four byte value in the Endianness that the
current system uses.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/set.xml b/reference/quickhash/quickhashinthash/set.xml
index bd9c228fdc47..89ffdfdb178f 100644
--- a/reference/quickhash/quickhashinthash/set.xml
+++ b/reference/quickhash/quickhashinthash/set.xml
@@ -14,14 +14,14 @@
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method tries to update an entry with a new value. In case the entry
did not yet exist, it will instead add a new entry. It returns whether the
entry was added or update. If there are duplicate keys, only the first
found element will get an updated value. Use
<constant>QuickHashIntHash::CHECK_FOR_DUPES</constant> during hash creation to prevent duplicate
keys from being part of the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,17 +30,17 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to add or update.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <para>
+ <simpara>
The new value to set the entry with.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -48,10 +48,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
2 if the entry was found and updated, 1 if the entry was newly added or 0
if there was an error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashinthash/update.xml b/reference/quickhash/quickhashinthash/update.xml
index 8459737cd223..2f519c976bae 100644
--- a/reference/quickhash/quickhashinthash/update.xml
+++ b/reference/quickhash/quickhashinthash/update.xml
@@ -13,12 +13,12 @@
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method updates an entry with a new value, and returns whether the entry was
update. If there are duplicate keys, only the first found element will get
an updated value. Use <constant>QuickHashIntHash::CHECK_FOR_DUPES</constant> during hash
creation to prevent duplicate keys from being part of the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,17 +27,17 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to update.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <para>
+ <simpara>
The new value to update the entry with.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,10 +45,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was found and updated, and &false; if the entry was
not part of the hash already.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintset.xml b/reference/quickhash/quickhashintset.xml
index c40f01fe84ff..f4f67f0fd375 100644
--- a/reference/quickhash/quickhashintset.xml
+++ b/reference/quickhash/quickhashintset.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.quickhashintset" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.quickhashintset" role="class">
<title>The QuickHashIntSet class</title>
<titleabbrev>QuickHashIntSet</titleabbrev>
@@ -11,14 +10,14 @@
<!-- {{{ QuickHashIntSet intro -->
<section xml:id="quickhashintset.intro">
&reftitle.intro;
- <para>
+ <simpara>
This class wraps around a set containing integer numbers.
- </para>
- <para>
+ </simpara>
+ <simpara>
Sets can also be iterated over with <link linkend="control-structures.foreach"><literal>foreach</literal></link> as the <interfacename>Iterator</interfacename> interface is
implemented as well. The order of which elements are returned in is not
guaranteed.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -69,7 +68,7 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashintset')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashintset')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
@@ -83,42 +82,42 @@
<varlistentry xml:id="quickhashintset.constants.check-for-dupes">
<term><constant>QuickHashIntSet::CHECK_FOR_DUPES</constant></term>
<listitem>
- <para>If enabled, adding duplicate elements to a set (through either <methodname>QuickHashIntSet::add</methodname> or
+ <simpara>If enabled, adding duplicate elements to a set (through either <methodname>QuickHashIntSet::add</methodname> or
<methodname>QuickHashIntSet::loadFromFile</methodname>) will result in those elements to be dropped from the
- set. This will take up extra time, so only used when it is required.</para>
+ set. This will take up extra time, so only used when it is required.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintset.constants.do-not-use-zend-alloc">
<term><constant>QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC</constant></term>
<listitem>
- <para>Disables the use of PHP's internal memory manager for internal
+ <simpara>Disables the use of PHP's internal memory manager for internal
set structures. With this option enabled, internal allocations will not
- count towards the <link linkend="ini.memory-limit">memory_limit</link> settings.</para>
+ count towards the <link linkend="ini.memory-limit">memory_limit</link> settings.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintset.constants.hasher-no-hash">
<term><constant>QuickHashIntSet::HASHER_NO_HASH</constant></term>
<listitem>
- <para>Selects to not use a hashing function, but merely use a modulo to
+ <simpara>Selects to not use a hashing function, but merely use a modulo to
find the bucket list index. This is not faster than normal hashing, and
- gives more collisions.</para>
+ gives more collisions.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintset.constants.hasher-jenkins1">
<term><constant>QuickHashIntSet::HASHER_JENKINS1</constant></term>
<listitem>
- <para>This is the default hashing function to turn the integer hashes
- into bucket list indexes.</para>
+ <simpara>This is the default hashing function to turn the integer hashes
+ into bucket list indexes.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintset.constants.hasher-jenkins2">
<term><constant>QuickHashIntSet::HASHER_JENKINS2</constant></term>
<listitem>
- <para>Selects a variant hashing algorithm.</para>
+ <simpara>Selects a variant hashing algorithm.</simpara>
</listitem>
</varlistentry>
@@ -132,7 +131,6 @@
&reference.quickhash.entities.quickhashintset;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintset/add.xml b/reference/quickhash/quickhashintset/add.xml
index 8774da5b51d6..2a38463881fa 100644
--- a/reference/quickhash/quickhashintset/add.xml
+++ b/reference/quickhash/quickhashintset/add.xml
@@ -12,11 +12,11 @@
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntSet::add</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method adds a new entry to the set, and returns whether the entry was
added. Entries are by default always added unless
<constant>QuickHashIntSet::CHECK_FOR_DUPES</constant> has been passed when the set was created.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to add.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was added, and &false; if the entry was not added.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintset/construct.xml b/reference/quickhash/quickhashintset/construct.xml
index 91d93ce0708e..be488e71f3ae 100644
--- a/reference/quickhash/quickhashintset/construct.xml
+++ b/reference/quickhash/quickhashintset/construct.xml
@@ -13,11 +13,11 @@
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This constructor creates a new <classname>QuickHashIntSet</classname>. The size is the amount of
bucket lists to create. The more lists there are, the less collisions you
will have. Options are also supported.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,17 +26,17 @@
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The options that you can pass in are: <constant>QuickHashIntSet::CHECK_FOR_DUPES</constant>,
which makes sure no duplicate entries are added to the set;
<constant>QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC</constant> to not use PHP's internal memory
@@ -44,7 +44,7 @@
<constant>QuickHashIntSet::HASHER_JENKINS1</constant> or <constant>QuickHashIntSet::HASHER_JENKINS2</constant>.
These last three configure which hashing algorithm to use. All options
can be combined using bitmasks.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,9 +52,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashIntSet</classname> object.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintset/delete.xml b/reference/quickhash/quickhashintset/delete.xml
index dc00e7bdacba..a54d42390219 100644
--- a/reference/quickhash/quickhashintset/delete.xml
+++ b/reference/quickhash/quickhashintset/delete.xml
@@ -12,11 +12,11 @@
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntSet::delete</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method deletes an entry from the set, and returns whether the entry was
deleted or not. Associated memory structures will not be freed immediately,
but rather when the set itself is freed.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to delete.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was deleted, and &false; if the entry was not deleted.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintset/exists.xml b/reference/quickhash/quickhashintset/exists.xml
index b575e30dce20..80462da314b5 100644
--- a/reference/quickhash/quickhashintset/exists.xml
+++ b/reference/quickhash/quickhashintset/exists.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntSet::exists</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method checks whether an entry with the provided key exists in the
set.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to check for whether it exists in the set.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,10 +34,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; when the entry was found, or &false; when the entry is not
found.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintset/getsize.xml b/reference/quickhash/quickhashintset/getsize.xml
index a95442cb9d42..4a9c6d7470a0 100644
--- a/reference/quickhash/quickhashintset/getsize.xml
+++ b/reference/quickhash/quickhashintset/getsize.xml
@@ -11,9 +11,9 @@
<methodsynopsis>
<modifier>public</modifier><type>int</type><methodname>QuickHashIntSet::getSize</methodname><void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns the number of elements in the set.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
The number of elements in the set.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintset/loadfromfile.xml b/reference/quickhash/quickhashintset/loadfromfile.xml
index e0a7493d8c1d..b083b4306d03 100644
--- a/reference/quickhash/quickhashintset/loadfromfile.xml
+++ b/reference/quickhash/quickhashintset/loadfromfile.xml
@@ -14,11 +14,11 @@
<methodparam choice="opt"><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This factory method creates a new set from a definition file on disk. The
file format consists of 32 bit signed integers packed together in the
Endianness that the system that the code runs on uses.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,30 +27,30 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
The filename of the file to read the set from.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The same options that the class' constructor takes; except that the size
option is ignored. It is automatically calculated to be the same as the
number of entries in the set, rounded up to the nearest power of two
with a maximum limit of <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -58,9 +58,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashIntSet</classname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintset/loadfromstring.xml b/reference/quickhash/quickhashintset/loadfromstring.xml
index fcb928cd7154..d3d0001c3211 100644
--- a/reference/quickhash/quickhashintset/loadfromstring.xml
+++ b/reference/quickhash/quickhashintset/loadfromstring.xml
@@ -14,11 +14,11 @@
<methodparam choice="opt"><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This factory method creates a new set from a definition in a string. The
file format consists of 32 bit signed integers packed together in the
Endianness that the system that the code runs on uses.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,30 +27,30 @@
<varlistentry>
<term><parameter>contents</parameter></term>
<listitem>
- <para>
+ <simpara>
The string containing a serialized format of the set.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The same options that the class' constructor takes; except that the size
option is ignored. It is automatically calculated to be the same as the
number of entries in the set, rounded up to the nearest power of two
automatically limited from <literal>64</literal> to <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -58,9 +58,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashIntSet</classname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintset/savetofile.xml b/reference/quickhash/quickhashintset/savetofile.xml
index 3b16fd1f3d95..f3c55336a8f2 100644
--- a/reference/quickhash/quickhashintset/savetofile.xml
+++ b/reference/quickhash/quickhashintset/savetofile.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>void</type><methodname>QuickHashIntSet::saveToFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method stores an existing set to a file on disk, in the same format
that <methodname>QuickHashIntSet::loadFromFile</methodname> can read.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
The filename of the file to store the hash in.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintset/savetostring.xml b/reference/quickhash/quickhashintset/savetostring.xml
index c909955ae747..88739feed541 100644
--- a/reference/quickhash/quickhashintset/savetostring.xml
+++ b/reference/quickhash/quickhashintset/savetostring.xml
@@ -11,10 +11,10 @@
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>QuickHashIntSet::saveToString</methodname><void/>
</methodsynopsis>
- <para>
+ <simpara>
This method returns a serialized version of the set in the same format that
<methodname>QuickHashIntSet::loadFromString</methodname> can read.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,11 +24,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
This method returns a string containing a serialized format of the set.
Each element is stored as a four byte value in the Endianness that the
current system uses.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash.xml b/reference/quickhash/quickhashintstringhash.xml
index ba044dafbf39..b01650ddb663 100644
--- a/reference/quickhash/quickhashintstringhash.xml
+++ b/reference/quickhash/quickhashintstringhash.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.quickhashintstringhash" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.quickhashintstringhash" role="class">
<title>The QuickHashIntStringHash class</title>
<titleabbrev>QuickHashIntStringHash</titleabbrev>
@@ -11,16 +10,16 @@
<!-- {{{ QuickHashIntStringHash intro -->
<section xml:id="quickhashintstringhash.intro">
&reftitle.intro;
- <para>
+ <simpara>
This class wraps around a hash containing integer numbers, where the
values are strings. Hashes are also available as implementation of the
<interfacename>ArrayAccess</interfacename> interface.
- </para>
- <para>
+ </simpara>
+ <simpara>
Hashes can also be iterated over with <link linkend="control-structures.foreach"><literal>foreach</literal></link> as the <interfacename>Iterator</interfacename> interface is
implemented as well. The order of which elements are returned in is not
guaranteed.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -69,9 +68,9 @@
<varname linkend="quickhashintstringhash.constants.hasher-jenkins2">QuickHashIntStringHash::HASHER_JENKINS2</varname>
<initializer>1024</initializer>
</fieldsynopsis>
-
+
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashintstringhash')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashintstringhash')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
@@ -85,42 +84,42 @@
<varlistentry xml:id="quickhashintstringhash.constants.check-for-dupes">
<term><constant>QuickHashIntStringHash::CHECK_FOR_DUPES</constant></term>
<listitem>
- <para>If enabled, adding duplicate elements to a set (through either <methodname>QuickHashIntStringHash::add</methodname> or
+ <simpara>If enabled, adding duplicate elements to a set (through either <methodname>QuickHashIntStringHash::add</methodname> or
<methodname>QuickHashIntStringHash::loadFromFile</methodname>) will result in those elements to be dropped from the
- set. This will take up extra time, so only used when it is required.</para>
+ set. This will take up extra time, so only used when it is required.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintstringhash.constants.do-not-use-zend-alloc">
<term><constant>QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC</constant></term>
<listitem>
- <para>Disables the use of PHP's internal memory manager for internal
+ <simpara>Disables the use of PHP's internal memory manager for internal
set structures. With this option enabled, internal allocations will not
- count towards the <link linkend="ini.memory-limit">memory_limit</link> settings.</para>
+ count towards the <link linkend="ini.memory-limit">memory_limit</link> settings.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintstringhash.constants.hasher-no-hash">
<term><constant>QuickHashIntStringHash::HASHER_NO_HASH</constant></term>
<listitem>
- <para>Selects to not use a hashing function, but merely use a modulo to
+ <simpara>Selects to not use a hashing function, but merely use a modulo to
find the bucket list index. This is not faster than normal hashing, and
- gives more collisions.</para>
+ gives more collisions.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintstringhash.constants.hasher-jenkins1">
<term><constant>QuickHashIntStringHash::HASHER_JENKINS1</constant></term>
<listitem>
- <para>This is the default hashing function to turn the integer hashes
- into bucket list indexes.</para>
+ <simpara>This is the default hashing function to turn the integer hashes
+ into bucket list indexes.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintstringhash.constants.hasher-jenkins2">
<term><constant>QuickHashIntStringHash::HASHER_JENKINS2</constant></term>
<listitem>
- <para>Selects a variant hashing algorithm.</para>
+ <simpara>Selects a variant hashing algorithm.</simpara>
</listitem>
</varlistentry>
@@ -134,7 +133,6 @@
&reference.quickhash.entities.quickhashintstringhash;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/add.xml b/reference/quickhash/quickhashintstringhash/add.xml
index 266bc45fc0d7..8c1da7fe83a7 100644
--- a/reference/quickhash/quickhashintstringhash/add.xml
+++ b/reference/quickhash/quickhashintstringhash/add.xml
@@ -13,11 +13,11 @@
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method adds a new entry to the hash, and returns whether the entry was
added. Entries are by default always added unless
<constant>QuickHashIntStringHash::CHECK_FOR_DUPES</constant> has been passed when the hash was created.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,18 +26,18 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to add.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <para>
+ <simpara>
The value of the entry to add. If a non-string is passed, it will be
converted to a string automatically if possible.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,9 +45,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was added, and &false; if the entry was not added.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/construct.xml b/reference/quickhash/quickhashintstringhash/construct.xml
index af5107662b97..d9a8ff8cc104 100644
--- a/reference/quickhash/quickhashintstringhash/construct.xml
+++ b/reference/quickhash/quickhashintstringhash/construct.xml
@@ -13,11 +13,11 @@
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This constructor creates a new <classname>QuickHashIntStringHash</classname>. The size is the amount of
bucket lists to create. The more lists there are, the less collisions you
will have. Options are also supported.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,17 +26,17 @@
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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 <literal>64</literal> to <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The options that you can pass in are: <constant>QuickHashIntStringHash::CHECK_FOR_DUPES</constant>,
which makes sure no duplicate entries are added to the hash;
<constant>QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC</constant> to not use PHP's internal memory
@@ -44,7 +44,7 @@
<constant>QuickHashIntStringHash::HASHER_JENKINS1</constant> or <constant>QuickHashIntStringHash::HASHER_JENKINS2</constant>.
These last three configure which hashing algorithm to use. All options
can be combined using bitmasks.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,9 +52,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashIntStringHash</classname> object.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/delete.xml b/reference/quickhash/quickhashintstringhash/delete.xml
index 5c05642b9566..db78a1f4d47b 100644
--- a/reference/quickhash/quickhashintstringhash/delete.xml
+++ b/reference/quickhash/quickhashintstringhash/delete.xml
@@ -12,16 +12,16 @@
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntStringHash::delete</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method deletes an entry from the hash, and returns whether the entry was
deleted or not. Associated memory structures will not be freed immediately,
but rather when the hash itself is freed.
- </para>
- <para>
+ </simpara>
+ <simpara>
Elements can not be deleted when the hash is used in an iterator. The
method will not throw an exception, but simply return &false; like would
happen with any other deletion failure.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,9 +30,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to delete.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +40,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was deleted, and &false; if the entry was not deleted.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/exists.xml b/reference/quickhash/quickhashintstringhash/exists.xml
index f260f352f93e..02aeedee0f8d 100644
--- a/reference/quickhash/quickhashintstringhash/exists.xml
+++ b/reference/quickhash/quickhashintstringhash/exists.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntStringHash::exists</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method checks whether an entry with the provided key exists in the
hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to check for whether it exists in the hash.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,10 +34,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; when the entry was found, or &false; when the entry is not
found.
- </para>
+ </simpara>
</refsect1>
</refentry>
diff --git a/reference/quickhash/quickhashintstringhash/get.xml b/reference/quickhash/quickhashintstringhash/get.xml
index 6fe35e71c1be..4d25e125d133 100644
--- a/reference/quickhash/quickhashintstringhash/get.xml
+++ b/reference/quickhash/quickhashintstringhash/get.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>QuickHashIntStringHash::get</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method retrieves a value from the hash by its key.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to retrieve.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
The value if the key exists, or &null; if the key wasn't part of the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/getsize.xml b/reference/quickhash/quickhashintstringhash/getsize.xml
index 5a766e07c4b8..759f0a9cc043 100644
--- a/reference/quickhash/quickhashintstringhash/getsize.xml
+++ b/reference/quickhash/quickhashintstringhash/getsize.xml
@@ -11,9 +11,9 @@
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>QuickHashIntStringHash::getSize</methodname><void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns the number of elements in the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
The number of elements in the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/loadfromfile.xml b/reference/quickhash/quickhashintstringhash/loadfromfile.xml
index 434761817352..c4399960ab45 100644
--- a/reference/quickhash/quickhashintstringhash/loadfromfile.xml
+++ b/reference/quickhash/quickhashintstringhash/loadfromfile.xml
@@ -14,7 +14,7 @@
<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>
+ <simpara>
This factory method creates a new hash from a definition file on disk. The
file format consists of a signature <literal>'QH\0x12\0'</literal>, the number of elements as
a 32 bit signed integer in system Endianness, an unsigned 32 bit integer
@@ -23,7 +23,7 @@
elements follow in pairs of two unsigned 32 bit integers where the first
one is the key, and the second one the index in the element data
string. An example could be:
- </para>
+ </simpara>
<example>
<title>QuickHash IntString file format</title>
<screen><![CDATA[00000000 51 48 12 00 02 00 00 00 09 00 00 00 4f 4e 45 00 |QH..........ONE.|
@@ -65,30 +65,30 @@ key/value 2 (key = 3, string index = 4 ("NINE")):
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
The filename of the file to read the hash from.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The same options that the class' constructor takes; except that the size
option is ignored. It is automatically calculated to be the same as the
number of entries in the hash, rounded up to the nearest power of two
with a maximum limit of <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -96,9 +96,9 @@ key/value 2 (key = 3, string index = 4 ("NINE")):
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashIntStringHash</classname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/loadfromstring.xml b/reference/quickhash/quickhashintstringhash/loadfromstring.xml
index de5ba16b851a..eeb787754835 100644
--- a/reference/quickhash/quickhashintstringhash/loadfromstring.xml
+++ b/reference/quickhash/quickhashintstringhash/loadfromstring.xml
@@ -14,10 +14,10 @@
<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>
+ <simpara>
This factory method creates a new hash from a definition in a string. The
format is the same as the one used in "loadFromFile".
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,30 +26,30 @@
<varlistentry>
<term><parameter>contents</parameter></term>
<listitem>
- <para>
+ <simpara>
The string containing a serialized format of the hash.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The same options that the class' constructor takes; except that the size
option is ignored. It is automatically calculated to be the same as the
number of entries in the hash, rounded up to the nearest power of two
with a maximum limit of 4194304.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -57,9 +57,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new QuickHashIntStringHash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/savetofile.xml b/reference/quickhash/quickhashintstringhash/savetofile.xml
index 93d0d14aa2b7..7e4a000c8b6f 100644
--- a/reference/quickhash/quickhashintstringhash/savetofile.xml
+++ b/reference/quickhash/quickhashintstringhash/savetofile.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>void</type><methodname>QuickHashIntStringHash::saveToFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method stores an existing hash to a file on disk, in the same format
that loadFromFile() can read.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
The filename of the file to store the hash in.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/savetostring.xml b/reference/quickhash/quickhashintstringhash/savetostring.xml
index 3b768d66e809..bdf4eee30f60 100644
--- a/reference/quickhash/quickhashintstringhash/savetostring.xml
+++ b/reference/quickhash/quickhashintstringhash/savetostring.xml
@@ -11,10 +11,10 @@
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>QuickHashIntStringHash::saveToString</methodname><void/>
</methodsynopsis>
- <para>
+ <simpara>
This method returns a serialized version of the hash in the same format that
<methodname>QuickHashIntStringHash::loadFromString</methodname> can read.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,11 +24,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
This method returns a string containing a serialized format of the hash.
Each element is stored as a four byte value in the Endianness that the
current system uses.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/set.xml b/reference/quickhash/quickhashintstringhash/set.xml
index 88b6d37b29c0..7eda7c21bd40 100644
--- a/reference/quickhash/quickhashintstringhash/set.xml
+++ b/reference/quickhash/quickhashintstringhash/set.xml
@@ -14,14 +14,14 @@
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method tries to update an entry with a new value. In case the entry
did not yet exist, it will instead add a new entry. It returns whether the
entry was added or update. If there are duplicate keys, only the first
found element will get an updated value. Use
QuickHashIntStringHash::CHECK_FOR_DUPES during hash creation to prevent duplicate
keys from being part of the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,18 +30,18 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to add or update.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <para>
+ <simpara>
The value of the entry to add. If a non-string is passed, it will be
converted to a string automatically if possible.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -49,10 +49,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
2 if the entry was found and updated, 1 if the entry was newly added or 0
if there was an error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashintstringhash/update.xml b/reference/quickhash/quickhashintstringhash/update.xml
index 5d1434422d83..c049ace25116 100644
--- a/reference/quickhash/quickhashintstringhash/update.xml
+++ b/reference/quickhash/quickhashintstringhash/update.xml
@@ -13,12 +13,12 @@
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method updates an entry with a new value, and returns whether the entry was
update. If there are duplicate keys, only the first found element will get
an updated value. Use QuickHashIntStringHash::CHECK_FOR_DUPES during hash
creation to prevent duplicate keys from being part of the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,18 +27,18 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to update.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <para>
+ <simpara>
The new value for the entry. If a non-string is passed, it will be
converted to a string automatically if possible.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,10 +46,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was found and updated, and &false; if the entry was
not part of the hash already.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash.xml b/reference/quickhash/quickhashstringinthash.xml
index e8b8b9c4730e..7267486d8bbe 100644
--- a/reference/quickhash/quickhashstringinthash.xml
+++ b/reference/quickhash/quickhashstringinthash.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.quickhashstringinthash" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.quickhashstringinthash" role="class">
<title>The QuickHashStringIntHash class</title>
<titleabbrev>QuickHashStringIntHash</titleabbrev>
@@ -11,16 +10,16 @@
<!-- {{{ QuickHashStringIntHash intro -->
<section xml:id="quickhashstringinthash.intro">
&reftitle.intro;
- <para>
+ <simpara>
This class wraps around a hash containing strings, where the
values are integer numbers. Hashes are also available as
implementation of the <interfacename>ArrayAccess</interfacename> interface.
- </para>
- <para>
+ </simpara>
+ <simpara>
Hashes can also be iterated over with <link linkend="control-structures.foreach"><literal>foreach</literal></link> as the <interfacename>Iterator</interfacename> interface is
implemented as well. The order of which elements are returned in is not
guaranteed.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -53,7 +52,7 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashstringinthash')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashstringinthash')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
@@ -67,18 +66,18 @@
<varlistentry xml:id="quickhashstringinthash.constants.check-for-dupes">
<term><constant>QuickHashStringIntHash::CHECK_FOR_DUPES</constant></term>
<listitem>
- <para>If enabled, adding duplicate elements to a set (through either <methodname>QuickHashStringIntHash::add</methodname> or
+ <simpara>If enabled, adding duplicate elements to a set (through either <methodname>QuickHashStringIntHash::add</methodname> or
<methodname>QuickHashStringIntHash::loadFromFile</methodname>) will result in those elements to be dropped from the
- set. This will take up extra time, so only used when it is required.</para>
+ set. This will take up extra time, so only used when it is required.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashstringinthash.constants.do-not-use-zend-alloc">
<term><constant>QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC</constant></term>
<listitem>
- <para>Disables the use of PHP's internal memory manager for internal
+ <simpara>Disables the use of PHP's internal memory manager for internal
set structures. With this option enabled, internal allocations will not
- count towards the <link linkend="ini.memory-limit">memory_limit</link> settings.</para>
+ count towards the <link linkend="ini.memory-limit">memory_limit</link> settings.</simpara>
</listitem>
</varlistentry>
@@ -92,7 +91,6 @@
&reference.quickhash.entities.quickhashstringinthash;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/add.xml b/reference/quickhash/quickhashstringinthash/add.xml
index e8bcf7c1e0d5..9a39d5a111a7 100644
--- a/reference/quickhash/quickhashstringinthash/add.xml
+++ b/reference/quickhash/quickhashstringinthash/add.xml
@@ -13,11 +13,11 @@
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method adds a new entry to the hash, and returns whether the entry was
added. Entries are by default always added unless
<constant>QuickHashStringIntHash::CHECK_FOR_DUPES</constant> has been passed when the hash was created.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,17 +26,17 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to add.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <para>
+ <simpara>
The value of the entry to add.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,9 +44,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was added, and &false; if the entry was not added.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/construct.xml b/reference/quickhash/quickhashstringinthash/construct.xml
index 7e1c3424c9b4..c64878013cd6 100644
--- a/reference/quickhash/quickhashstringinthash/construct.xml
+++ b/reference/quickhash/quickhashstringinthash/construct.xml
@@ -13,11 +13,11 @@
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This constructor creates a new <classname>QuickHashStringIntHash</classname>. The size is the amount of
bucket lists to create. The more lists there are, the less collisions you
will have. Options are also supported.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,23 +26,23 @@
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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 <literal>64</literal> to <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The options that you can pass in are:
<constant>QuickHashStringIntHash::CHECK_FOR_DUPES</constant>, which makes sure no duplicate
entries are added to the hash and
<constant>QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC</constant> to not use PHP's internal
memory manager.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -50,9 +50,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashStringIntHash</classname> object.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/delete.xml b/reference/quickhash/quickhashstringinthash/delete.xml
index 76784b14ad50..dc73c7eb41b0 100644
--- a/reference/quickhash/quickhashstringinthash/delete.xml
+++ b/reference/quickhash/quickhashstringinthash/delete.xml
@@ -12,16 +12,16 @@
<modifier>public</modifier> <type>bool</type><methodname>QuickHashStringIntHash::delete</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method deletes an entry from the hash, and returns whether the entry was
deleted or not. Associated memory structures will not be freed immediately,
but rather when the hash itself is freed.
- </para>
- <para>
+ </simpara>
+ <simpara>
Elements can not be deleted when the hash is used in an iterator. The
method will not throw an exception, but simply return &false; like would
happen with any other deletion failure.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,9 +30,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to delete.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +40,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was deleted, and &false; if the entry was not deleted.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/exists.xml b/reference/quickhash/quickhashstringinthash/exists.xml
index 66701b93f778..770a6da1de72 100644
--- a/reference/quickhash/quickhashstringinthash/exists.xml
+++ b/reference/quickhash/quickhashstringinthash/exists.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>bool</type><methodname>QuickHashStringIntHash::exists</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method checks whether an entry with the provided key exists in the
hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to check for whether it exists in the hash.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,10 +34,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; when the entry was found, or &false; when the entry is not
found.
- </para>
+ </simpara>
</refsect1>
</refentry>
diff --git a/reference/quickhash/quickhashstringinthash/get.xml b/reference/quickhash/quickhashstringinthash/get.xml
index ccb18bca6262..92e95eed4d82 100644
--- a/reference/quickhash/quickhashstringinthash/get.xml
+++ b/reference/quickhash/quickhashstringinthash/get.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>QuickHashStringIntHash::get</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method retrieves a value from the hash by its key.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to retrieve.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
The value if the key exists, or &null; if the key wasn't part of the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/getsize.xml b/reference/quickhash/quickhashstringinthash/getsize.xml
index 14e03d17817e..198da274aa38 100644
--- a/reference/quickhash/quickhashstringinthash/getsize.xml
+++ b/reference/quickhash/quickhashstringinthash/getsize.xml
@@ -11,9 +11,9 @@
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>QuickHashStringIntHash::getSize</methodname><void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns the number of elements in the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
The number of elements in the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/loadfromfile.xml b/reference/quickhash/quickhashstringinthash/loadfromfile.xml
index aabe822717b7..a98e309699fe 100644
--- a/reference/quickhash/quickhashstringinthash/loadfromfile.xml
+++ b/reference/quickhash/quickhashstringinthash/loadfromfile.xml
@@ -14,7 +14,7 @@
<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>
+ <simpara>
This factory method creates a new hash from a definition file on disk. The
file format consists of a signature <literal>'QH\0x21\0'</literal>, the number of elements as
a 32 bit signed integer in system Endianness, an unsigned 32 bit integer
@@ -28,7 +28,7 @@
unsigned 32 bit integers the elements, where the first one is the index
into the string list containing the keys, and the second one the value. An
example could be:
- </para>
+ </simpara>
<example>
<title>QuickHash StringIntHash file format</title>
<screen><![CDATA[00000000 51 48 21 00 02 00 00 00 09 00 00 00 40 00 00 00 |QH!.........@...|
@@ -77,30 +77,30 @@ bucket lists:
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
The filename of the file to read the hash from.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The same options that the class' constructor takes; except that the size
option is ignored. It is read from the file format (unlike the
<classname>QuickHashIntHash</classname> and <classname>QuickHashIntStringHash</classname> classes, where it is
automatically calculated from the number of entries in the hash.)
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -108,9 +108,9 @@ bucket lists:
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new <classname>QuickHashStringIntHash</classname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/loadfromstring.xml b/reference/quickhash/quickhashstringinthash/loadfromstring.xml
index 9524580fcf34..b11f61bfbbaa 100644
--- a/reference/quickhash/quickhashstringinthash/loadfromstring.xml
+++ b/reference/quickhash/quickhashstringinthash/loadfromstring.xml
@@ -14,10 +14,10 @@
<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>
+ <simpara>
This factory method creates a new hash from a definition in a string. The
format is the same as the one used in "loadFromFile".
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,30 +26,30 @@
<varlistentry>
<term><parameter>contents</parameter></term>
<listitem>
- <para>
+ <simpara>
The string containing a serialized format of the hash.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
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>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
- <para>
+ <simpara>
The same options that the class' constructor takes; except that the size
option is ignored. It is automatically calculated to be the same as the
number of entries in the hash, rounded up to the nearest power of two
with a maximum limit of 4194304.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -57,9 +57,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a new QuickHashStringIntHash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/savetofile.xml b/reference/quickhash/quickhashstringinthash/savetofile.xml
index 94eb30719a42..9a02a7024b10 100644
--- a/reference/quickhash/quickhashstringinthash/savetofile.xml
+++ b/reference/quickhash/quickhashstringinthash/savetofile.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>void</type><methodname>QuickHashStringIntHash::saveToFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method stores an existing hash to a file on disk, in the same format
that loadFromFile() can read.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
The filename of the file to store the hash in.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/savetostring.xml b/reference/quickhash/quickhashstringinthash/savetostring.xml
index 4cc25916088f..9560477cab0e 100644
--- a/reference/quickhash/quickhashstringinthash/savetostring.xml
+++ b/reference/quickhash/quickhashstringinthash/savetostring.xml
@@ -11,10 +11,10 @@
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>QuickHashStringIntHash::saveToString</methodname><void/>
</methodsynopsis>
- <para>
+ <simpara>
This method returns a serialized version of the hash in the same format that
<methodname>QuickHashStringIntHash::loadFromString</methodname> can read.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,10 +24,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
This method returns a serialized format of an existing hash, in the same format
that <methodname>QuickHashStringIntHash::loadFromString</methodname> can read.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/set.xml b/reference/quickhash/quickhashstringinthash/set.xml
index 013c008ddd8d..287e5d51803f 100644
--- a/reference/quickhash/quickhashstringinthash/set.xml
+++ b/reference/quickhash/quickhashstringinthash/set.xml
@@ -14,14 +14,14 @@
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method tries to update an entry with a new value. In case the entry
did not yet exist, it will instead add a new entry. It returns whether the
entry was added or update. If there are duplicate keys, only the first
found element will get an updated value. Use
QuickHashStringIntHash::CHECK_FOR_DUPES during hash creation to prevent duplicate
keys from being part of the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,18 +30,18 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to add or update.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <para>
+ <simpara>
The value of the entry to add. If a non-string is passed, it will be
converted to a string automatically if possible.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -49,10 +49,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
2 if the entry was found and updated, 1 if the entry was newly added or 0
if there was an error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/quickhashstringinthash/update.xml b/reference/quickhash/quickhashstringinthash/update.xml
index a4591f9a6557..e85e604a64e5 100644
--- a/reference/quickhash/quickhashstringinthash/update.xml
+++ b/reference/quickhash/quickhashstringinthash/update.xml
@@ -13,12 +13,12 @@
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method updates an entry with a new value, and returns whether the entry was
update. If there are duplicate keys, only the first found element will get
an updated value. Use QuickHashStringIntHash::CHECK_FOR_DUPES during hash
creation to prevent duplicate keys from being part of the hash.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,18 +27,18 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The key of the entry to update.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <para>
+ <simpara>
The new value for the entry. If a non-string is passed, it will be
converted to a string automatically if possible.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,10 +46,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true; when the entry was found and updated, and &false; if the entry was
not part of the hash already.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/quickhash/setup.xml b/reference/quickhash/setup.xml
index b5e08160c3ff..845652e51805 100644
--- a/reference/quickhash/setup.xml
+++ b/reference/quickhash/setup.xml
@@ -1,26 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="quickhash.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhash.setup">
&reftitle.setup;
<section xml:id="quickhash.requirements">
&reftitle.required;
- <para>
+ <simpara>
This extension requires no additional libraries.
- </para>
+ </simpara>
</section>
<section xml:id="quickhash.installation">
&reftitle.install;
- <para>
+ <simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;quickhash">&url.pecl.package;quickhash</link>
- </para>
+ </simpara>
</section>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -41,4 +39,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-