[DOC-CVS] [doc-en] master: quickhash: fix XML to remove useless wrapping para 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/0fdb7dede54d021c3f26029f95036ac7d3e621e9
Raw diff: https://github.com/php/doc-en/commit/0fdb7dede54d021c3f26029f95036ac7d3e621e9.diff
quickhash: fix XML to remove useless wrapping para tags via script
Changed paths:
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/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/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/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
Diff:
diff --git a/reference/quickhash/quickhashinthash/add.xml b/reference/quickhash/quickhashinthash/add.xml
index 5074a39bdf22..f1327626783a 100644
--- a/reference/quickhash/quickhashinthash/add.xml
+++ b/reference/quickhash/quickhashinthash/add.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.add">
<refnamediv>
<refname>QuickHashIntHash::add</refname>
<refpurpose>This method adds a new entry to the hash</refpurpose>
@@ -23,27 +22,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to add.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The optional value of the entry to add. If no value is specified,
- <literal>1</literal> will be used.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to add.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The optional value of the entry to add. If no value is specified,
+ <literal>1</literal> will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -55,10 +52,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::add</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::add</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
echo "without dupe checking\n";
@@ -84,9 +80,9 @@ var_dump( $hash->add( 5 ) );
var_dump( $hash->get( 5 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
without dupe checking
bool(false)
@@ -108,14 +104,12 @@ default value
bool(true)
int(1)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/construct.xml b/reference/quickhash/quickhashinthash/construct.xml
index 2f4d5540177c..c6902e278526 100644
--- a/reference/quickhash/quickhashinthash/construct.xml
+++ b/reference/quickhash/quickhashinthash/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.construct">
<refnamediv>
<refname>QuickHashIntHash::__construct</refname>
<refpurpose>Creates a new QuickHashIntHash object</refpurpose>
@@ -23,34 +22,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <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 <literal>64</literal> to <literal>4194304</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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
- manager as well as one of <constant>QuickHashIntHash::HASHER_NO_HASH</constant>,
- <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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <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 <literal>64</literal> to <literal>4194304</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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
+ manager as well as one of <constant>QuickHashIntHash::HASHER_NO_HASH</constant>,
+ <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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -62,10 +59,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::__construct</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::__construct</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
var_dump( new QuickHashIntHash( 1024 ) );
@@ -73,19 +69,17 @@ var_dump( new QuickHashIntHash( 1024, QuickHashIntHash::CHECK_FOR_DUPES ) );
var_dump(
new QuickHashIntHash(
1024,
- QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC | QuickHashIntHash::HASHER_JENKINS2
+ QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC | QuickHashIntHash::HASHER_JENKINS2
)
);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/delete.xml b/reference/quickhash/quickhashinthash/delete.xml
index 6428f69677db..70d3dfd451d7 100644
--- a/reference/quickhash/quickhashinthash/delete.xml
+++ b/reference/quickhash/quickhashinthash/delete.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.delete">
<refnamediv>
<refname>QuickHashIntHash::delete</refname>
<refpurpose>This method deletes an entry from the hash</refpurpose>
@@ -27,18 +26,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to delete.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to delete.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -50,10 +47,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::delete</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::delete</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntHash( 1024 );
@@ -64,9 +60,9 @@ var_dump( $hash->exists( 4 ) );
var_dump( $hash->delete( 4 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
bool(true)
@@ -74,14 +70,12 @@ bool(true)
bool(false)
bool(false)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/exists.xml b/reference/quickhash/quickhashinthash/exists.xml
index d8a91c37c637..aa738e7aebfd 100644
--- a/reference/quickhash/quickhashinthash/exists.xml
+++ b/reference/quickhash/quickhashinthash/exists.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.exists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.exists">
<refnamediv>
<refname>QuickHashIntHash::exists</refname>
<refpurpose>This method checks whether a key is part of the hash</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to check for whether it exists in the hash.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to check for whether it exists in the hash.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -45,10 +42,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::exists</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::exists</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
//generate 200000 elements
@@ -73,23 +69,21 @@ foreach( $testForEntries as $key )
echo "Done, $foundCount found: ", microtime( true ), "\n";
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Creating hash: 1263588703.0748
Adding elements: 1263588703.0757
Doing 1000 tests: 1263588703.7851
Done, 898 found: 1263588703.7897
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/get.xml b/reference/quickhash/quickhashinthash/get.xml
index ac2f704dddcb..1473a7a48db4 100644
--- a/reference/quickhash/quickhashinthash/get.xml
+++ b/reference/quickhash/quickhashinthash/get.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.get">
<refnamediv>
<refname>QuickHashIntHash::get</refname>
<refpurpose>This method retrieves a value from the hash by its key</refpurpose>
@@ -20,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to retrieve.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to retrieve.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,10 +40,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::get</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::get</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntHash( 8 );
@@ -59,9 +55,9 @@ var_dump( $hash->add( 3, 5 ) );
var_dump( $hash->get( 3 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
bool(true)
@@ -69,14 +65,12 @@ int(1)
bool(true)
int(5)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/getsize.xml b/reference/quickhash/quickhashinthash/getsize.xml
index 7f6b8b3d0b9c..a2fdbec19f02 100644
--- a/reference/quickhash/quickhashinthash/getsize.xml
+++ b/reference/quickhash/quickhashinthash/getsize.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.getsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.getsize">
<refnamediv>
<refname>QuickHashIntHash::getSize</refname>
<refpurpose>Returns the number of elements in the hash</refpurpose>
@@ -31,10 +30,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::getSize</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::getSize</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntHash( 8 );
@@ -43,22 +41,20 @@ var_dump( $hash->add( 3, 5 ) );
var_dump( $hash->getSize() );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(true)
bool(true)
int(2)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/loadfromfile.xml b/reference/quickhash/quickhashinthash/loadfromfile.xml
index 39a22e93d5de..eef548f39ed1 100644
--- a/reference/quickhash/quickhashinthash/loadfromfile.xml
+++ b/reference/quickhash/quickhashinthash/loadfromfile.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.loadfromfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.loadfromfile">
<refnamediv>
<refname>QuickHashIntHash::loadFromFile</refname>
<refpurpose>This factory method creates a hash from a file</refpurpose>
@@ -23,19 +22,16 @@
stored. The first of each element is the key, and the second is the value
belonging to the key. An example could be:
</para>
- <para>
- <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..............|
+ <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..............|
00000010 03 00 00 00 09 00 00 00 |........|
00000018
]]></screen>
- </example>
- </para>
- <para>
- <example>
- <title>QuickHash IntHash file format</title>
- <screen><![CDATA[header signature ('QH'; key type: 1; value type: 1; filler: \0x00)
+ </example>
+ <example>
+ <title>QuickHash IntHash file format</title>
+ <screen><![CDATA[header signature ('QH'; key type: 1; value type: 1; filler: \0x00)
00000000 51 48 11 00
number of elements:
@@ -50,36 +46,33 @@ key/value 1 (key = 1, value = 1)
key/value 2 (key = 3, value = 9)
03 00 00 00 09 00 00 00
]]></screen>
- </example>
- </para>
+ </example>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The filename of the file to read the hash from.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The filename of the file to read the hash from.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -91,10 +84,9 @@ key/value 2 (key = 3, value = 9)
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::loadFromFile</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::loadFromFile</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$file = dirname( __FILE__ ) . "/simple.hash";
@@ -111,9 +103,9 @@ foreach( range( 0, 0x0f ) as $key )
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Key 0 ( 0) is unset
Key 1 ( 1) is set
@@ -132,14 +124,12 @@ Key 13 ( d) is set
Key 14 ( e) is unset
Key 15 ( f) is unset
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/loadfromstring.xml b/reference/quickhash/quickhashinthash/loadfromstring.xml
index abd70691232e..f359d1b249cd 100644
--- a/reference/quickhash/quickhashinthash/loadfromstring.xml
+++ b/reference/quickhash/quickhashinthash/loadfromstring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.loadfromstring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.loadfromstring">
<refnamediv>
<refname>QuickHashIntHash::loadFromString</refname>
<refpurpose>This factory method creates a hash from a string</refpurpose>
@@ -25,29 +24,27 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>contents</parameter></term>
- <listitem>
- <para>
- The string containing a serialized format of the hash.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>contents</parameter></term>
+ <listitem>
+ <para>
+ The string containing a serialized format of the hash.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -59,10 +56,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::loadFromString</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::loadFromString</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$contents = file_get_contents( dirname( __FILE__ ) . "/simple.hash" );
@@ -79,9 +75,9 @@ foreach( range( 0, 0x0f ) as $key )
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Key 0 ( 0) is unset
Key 1 ( 1) is set
@@ -100,14 +96,12 @@ Key 13 ( d) is set
Key 14 ( e) is unset
Key 15 ( f) is unset
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/savetofile.xml b/reference/quickhash/quickhashinthash/savetofile.xml
index 598ff44c50fe..edc596f1f186 100644
--- a/reference/quickhash/quickhashinthash/savetofile.xml
+++ b/reference/quickhash/quickhashinthash/savetofile.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.savetofile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.savetofile">
<refnamediv>
<refname>QuickHashIntHash::saveToFile</refname>
<refpurpose>This method stores an in-memory hash to disk</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The filename of the file to store the hash in.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The filename of the file to store the hash in.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,10 +41,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::saveToFile</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::saveToFile</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntHash( 1024 );
@@ -59,14 +55,12 @@ var_dump( $hash->add( 4, 52 ) );
$hash->saveToFile( '/tmp/test.hash' );
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/savetostring.xml b/reference/quickhash/quickhashinthash/savetostring.xml
index 5c7dace564bf..c9dd7f93b69a 100644
--- a/reference/quickhash/quickhashinthash/savetostring.xml
+++ b/reference/quickhash/quickhashinthash/savetostring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.savetostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.savetostring">
<refnamediv>
<refname>QuickHashIntHash::saveToString</refname>
<refpurpose>This method returns a serialized version of the hash</refpurpose>
@@ -34,10 +33,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::saveToString</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::saveToString</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntHash( 1024 );
@@ -49,14 +47,12 @@ var_dump( $hash->add( 4, 55 ) );
var_dump( $hash->saveToString() );
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/set.xml b/reference/quickhash/quickhashinthash/set.xml
index 13d4dd22aa54..bd9c228fdc47 100644
--- a/reference/quickhash/quickhashinthash/set.xml
+++ b/reference/quickhash/quickhashinthash/set.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.set">
<refnamediv>
<refname>QuickHashIntHash::set</refname>
<refpurpose>This method updates an entry in the hash with a new value, or
@@ -27,26 +26,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to add or update.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The new value to set the entry with.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to add or update.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The new value to set the entry with.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -59,10 +56,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::set</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::set</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntHash( 1024 );
@@ -77,9 +73,9 @@ var_dump( $hash->set( 46692, 29906 ) );
var_dump( $hash->get( 46692 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
int(2)
@@ -88,14 +84,12 @@ Set->Update
int(1)
int(29906)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashinthash/update.xml b/reference/quickhash/quickhashinthash/update.xml
index 812a5a99d0fc..8459737cd223 100644
--- a/reference/quickhash/quickhashinthash/update.xml
+++ b/reference/quickhash/quickhashinthash/update.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashinthash.update" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashinthash.update">
<refnamediv>
<refname>QuickHashIntHash::update</refname>
<refpurpose>This method updates an entry in the hash with a new value</refpurpose>
@@ -24,26 +23,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to update.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The new value to update the entry with.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to update.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The new value to update the entry with.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -56,10 +53,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntHash::update</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntHash::update</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntHash( 1024 );
@@ -69,22 +65,20 @@ var_dump( $hash->update( 141421, 223606 ) );
var_dump( $hash->get( 141421 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(true)
bool(true)
int(223606)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- 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 b0924eb27804..8774da5b51d6 100644
--- a/reference/quickhash/quickhashintset/add.xml
+++ b/reference/quickhash/quickhashintset/add.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintset.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.add">
<refnamediv>
<refname>QuickHashIntSet::add</refname>
<refpurpose>This method adds a new entry to the set</refpurpose>
@@ -22,18 +21,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to add.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to add.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -45,10 +42,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntSet::add</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntSet::add</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
echo "without dupe checking\n";
@@ -66,9 +62,9 @@ var_dump( $set->exists( 4 ) );
var_dump( $set->add( 4 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
without dupe checking
bool(false)
@@ -82,14 +78,12 @@ bool(true)
bool(true)
bool(false)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintset/construct.xml b/reference/quickhash/quickhashintset/construct.xml
index b2c4a9513455..91d93ce0708e 100644
--- a/reference/quickhash/quickhashintset/construct.xml
+++ b/reference/quickhash/quickhashintset/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintset.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.construct">
<refnamediv>
<refname>QuickHashIntSet::__construct</refname>
<refpurpose>Creates a new QuickHashIntSet object</refpurpose>
@@ -23,34 +22,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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
- manager as well as one of <constant>QuickHashIntSet::HASHER_NO_HASH</constant>,
- <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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <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 <literal>4</literal> to <literal>4194304</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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
+ manager as well as one of <constant>QuickHashIntSet::HASHER_NO_HASH</constant>,
+ <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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -62,10 +59,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntSet::__construct</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntSet::__construct</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
var_dump( new QuickHashIntSet( 1024 ) );
@@ -78,14 +74,12 @@ var_dump(
);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintset/delete.xml b/reference/quickhash/quickhashintset/delete.xml
index 8be54d445f8d..dc00e7bdacba 100644
--- a/reference/quickhash/quickhashintset/delete.xml
+++ b/reference/quickhash/quickhashintset/delete.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintset.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.delete">
<refnamediv>
<refname>QuickHashIntSet::delete</refname>
<refpurpose>This method deletes an entry from the set</refpurpose>
@@ -22,18 +21,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to delete.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to delete.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -45,10 +42,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntSet::delete</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntSet::delete</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$set = new QuickHashIntSet( 1024 );
@@ -59,9 +55,9 @@ var_dump( $set->exists( 4 ) );
var_dump( $set->delete( 4 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
bool(true)
@@ -69,14 +65,12 @@ bool(true)
bool(false)
bool(false)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintset/exists.xml b/reference/quickhash/quickhashintset/exists.xml
index a9b608234785..b575e30dce20 100644
--- a/reference/quickhash/quickhashintset/exists.xml
+++ b/reference/quickhash/quickhashintset/exists.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintset.exists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.exists">
<refnamediv>
<refname>QuickHashIntSet::exists</refname>
<refpurpose>This method checks whether a key is part of the set</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to check for whether it exists in the set.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to check for whether it exists in the set.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -45,10 +42,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntSet::exists</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntSet::exists</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
//generate 200000 elements
@@ -73,23 +69,21 @@ foreach( $testForEntries as $key )
echo "Done, $foundCount found: ", microtime( true ), "\n";
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Creating set: 1263588703.0748
Adding elements: 1263588703.0757
Doing 1000 tests: 1263588703.7851
Done, 898 found: 1263588703.7897
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintset/getsize.xml b/reference/quickhash/quickhashintset/getsize.xml
index fd5f04ed353f..a95442cb9d42 100644
--- a/reference/quickhash/quickhashintset/getsize.xml
+++ b/reference/quickhash/quickhashintset/getsize.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintset.getsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.getsize">
<refnamediv>
<refname>QuickHashIntSet::getSize</refname>
<refpurpose>Returns the number of elements in the set</refpurpose>
@@ -31,10 +30,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntSet::getSize</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntSet::getSize</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$set = new QuickHashIntSet( 8 );
@@ -43,22 +41,20 @@ var_dump( $set->add( 3 ) );
var_dump( $set->getSize() );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(true)
bool(true)
int(2)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintset/loadfromfile.xml b/reference/quickhash/quickhashintset/loadfromfile.xml
index bdd087987b67..e0a7493d8c1d 100644
--- a/reference/quickhash/quickhashintset/loadfromfile.xml
+++ b/reference/quickhash/quickhashintset/loadfromfile.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintset.loadfromfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.loadfromfile">
<refnamediv>
<refname>QuickHashIntSet::loadFromFile</refname>
<refpurpose>This factory method creates a set from a file</refpurpose>
@@ -24,39 +23,37 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The filename of the file to read the set from.
- </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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The filename of the file to read the set from.
+ </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 <literal>4</literal> to <literal>4194304</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -68,10 +65,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntSet::loadFromFile</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntSet::loadFromFile</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$file = dirname( __FILE__ ) . "/simple.set";
@@ -88,9 +84,9 @@ foreach( range( 0, 0x0f ) as $key )
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Key 0 ( 0) is unset
Key 1 ( 1) is set
@@ -109,14 +105,12 @@ Key 13 ( d) is set
Key 14 ( e) is unset
Key 15 ( f) is unset
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintset/loadfromstring.xml b/reference/quickhash/quickhashintset/loadfromstring.xml
index 9a4a4e300c12..fcb928cd7154 100644
--- a/reference/quickhash/quickhashintset/loadfromstring.xml
+++ b/reference/quickhash/quickhashintset/loadfromstring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintset.loadfromstring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.loadfromstring">
<refnamediv>
<refname>QuickHashIntSet::loadFromString</refname>
<refpurpose>This factory method creates a set from a string</refpurpose>
@@ -24,39 +23,37 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>contents</parameter></term>
- <listitem>
- <para>
- The string containing a serialized format of the set.
- </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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>contents</parameter></term>
+ <listitem>
+ <para>
+ The string containing a serialized format of the set.
+ </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 <literal>4</literal> to <literal>4194304</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -68,10 +65,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntSet::loadFromString</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntSet::loadFromString</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$contents = file_get_contents( dirname( __FILE__ ) . "/simple.set" );
@@ -88,9 +84,9 @@ foreach( range( 0, 0x0f ) as $key )
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Key 0 ( 0) is unset
Key 1 ( 1) is set
@@ -109,14 +105,12 @@ Key 13 ( d) is set
Key 14 ( e) is unset
Key 15 ( f) is unset
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintset/savetofile.xml b/reference/quickhash/quickhashintset/savetofile.xml
index e7cba4225d5f..3b16fd1f3d95 100644
--- a/reference/quickhash/quickhashintset/savetofile.xml
+++ b/reference/quickhash/quickhashintset/savetofile.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintset.savetofile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.savetofile">
<refnamediv>
<refname>QuickHashIntSet::saveToFile</refname>
<refpurpose>This method stores an in-memory set to disk</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The filename of the file to store the hash in.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The filename of the file to store the hash in.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,10 +41,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntSet::saveToFile</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntSet::saveToFile</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$set = new QuickHashIntSet( 1024 );
@@ -59,14 +55,12 @@ var_dump( $set->add( 4 ) );
$set->saveToFile( '/tmp/test.set' );
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintset/savetostring.xml b/reference/quickhash/quickhashintset/savetostring.xml
index 258756074c98..c909955ae747 100644
--- a/reference/quickhash/quickhashintset/savetostring.xml
+++ b/reference/quickhash/quickhashintset/savetostring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintset.savetostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.savetostring">
<refnamediv>
<refname>QuickHashIntSet::saveToString</refname>
<refpurpose>This method returns a serialized version of the set</refpurpose>
@@ -34,10 +33,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntSet::saveToString</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntSet::saveToString</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$set = new QuickHashIntSet( 1024 );
@@ -49,14 +47,12 @@ var_dump( $set->add( 4 ) );
var_dump( $set->saveToString() );
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- 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 ac87ebbe3026..266bc45fc0d7 100644
--- a/reference/quickhash/quickhashintstringhash/add.xml
+++ b/reference/quickhash/quickhashintstringhash/add.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.add">
<refnamediv>
<refname>QuickHashIntStringHash::add</refname>
<refpurpose>This method adds a new entry to the hash</refpurpose>
@@ -23,27 +22,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to add.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The value of the entry to add. If a non-string is passed, it will be
- converted to a string automatically if possible.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to add.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The value of the entry to add. If a non-string is passed, it will be
+ converted to a string automatically if possible.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -55,10 +52,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::add</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::add</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
echo "without dupe checking\n";
@@ -80,9 +76,9 @@ var_dump( $hash->get( 4 ) );
var_dump( $hash->add( 4, "nine" ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
without dupe checking
bool(false)
@@ -100,14 +96,12 @@ bool(true)
string(13) "seventy eight"
bool(false)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/construct.xml b/reference/quickhash/quickhashintstringhash/construct.xml
index 8448ada1c635..af5107662b97 100644
--- a/reference/quickhash/quickhashintstringhash/construct.xml
+++ b/reference/quickhash/quickhashintstringhash/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.construct">
<refnamediv>
<refname>QuickHashIntStringHash::__construct</refname>
<refpurpose>Creates a new QuickHashIntStringHash object</refpurpose>
@@ -23,34 +22,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <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 <literal>64</literal> to <literal>4194304</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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
- manager as well as one of <constant>QuickHashIntStringHash::HASHER_NO_HASH</constant>,
- <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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <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 <literal>64</literal> to <literal>4194304</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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
+ manager as well as one of <constant>QuickHashIntStringHash::HASHER_NO_HASH</constant>,
+ <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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -62,10 +59,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::__construct</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::__construct</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
var_dump( new QuickHashIntStringHash( 1024 ) );
@@ -78,14 +74,12 @@ var_dump(
);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/delete.xml b/reference/quickhash/quickhashintstringhash/delete.xml
index a39b380e7710..5c05642b9566 100644
--- a/reference/quickhash/quickhashintstringhash/delete.xml
+++ b/reference/quickhash/quickhashintstringhash/delete.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.delete">
<refnamediv>
<refname>QuickHashIntStringHash::delete</refname>
<refpurpose>This method deletes an entry from the hash</refpurpose>
@@ -27,18 +26,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to delete.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to delete.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -50,10 +47,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::delete</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::delete</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntStringHash( 1024 );
@@ -64,9 +60,9 @@ var_dump( $hash->exists( 4 ) );
var_dump( $hash->delete( 4 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
bool(true)
@@ -74,14 +70,12 @@ bool(true)
bool(false)
bool(false)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/exists.xml b/reference/quickhash/quickhashintstringhash/exists.xml
index d46833bbb305..f260f352f93e 100644
--- a/reference/quickhash/quickhashintstringhash/exists.xml
+++ b/reference/quickhash/quickhashintstringhash/exists.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.exists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.exists">
<refnamediv>
<refname>QuickHashIntStringHash::exists</refname>
<refpurpose>This method checks whether a key is part of the hash</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to check for whether it exists in the hash.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to check for whether it exists in the hash.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,7 +41,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/get.xml b/reference/quickhash/quickhashintstringhash/get.xml
index 36f37aef625e..6fe35e71c1be 100644
--- a/reference/quickhash/quickhashintstringhash/get.xml
+++ b/reference/quickhash/quickhashintstringhash/get.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.get">
<refnamediv>
<refname>QuickHashIntStringHash::get</refname>
<refpurpose>This method retrieves a value from the hash by its key</refpurpose>
@@ -20,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to retrieve.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to retrieve.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,10 +40,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::get</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::get</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntStringHash( 8 );
@@ -59,9 +55,9 @@ var_dump( $hash->add( 3, 5 ) );
var_dump( $hash->get( 3 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
bool(true)
@@ -69,14 +65,12 @@ string(3) "two"
bool(true)
string(1) "5"
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/getsize.xml b/reference/quickhash/quickhashintstringhash/getsize.xml
index b39271e7c662..5a766e07c4b8 100644
--- a/reference/quickhash/quickhashintstringhash/getsize.xml
+++ b/reference/quickhash/quickhashintstringhash/getsize.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.getsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.getsize">
<refnamediv>
<refname>QuickHashIntStringHash::getSize</refname>
<refpurpose>Returns the number of elements in the hash</refpurpose>
@@ -31,10 +30,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::getSize</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::getSize</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntStringHash( 8 );
@@ -43,22 +41,20 @@ var_dump( $hash->add( 3, 5 ) );
var_dump( $hash->getSize() );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(true)
bool(true)
int(2)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/loadfromfile.xml b/reference/quickhash/quickhashintstringhash/loadfromfile.xml
index 30e3d9fbf276..434761817352 100644
--- a/reference/quickhash/quickhashintstringhash/loadfromfile.xml
+++ b/reference/quickhash/quickhashintstringhash/loadfromfile.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.loadfromfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.loadfromfile">
<refnamediv>
<refname>QuickHashIntStringHash::loadFromFile</refname>
<refpurpose>This factory method creates a hash from a file</refpurpose>
@@ -25,20 +24,17 @@
one is the key, and the second one the index in the element data
string. An example could be:
</para>
- <para>
- <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.|
+ <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.|
00000010 4e 49 4e 45 00 01 00 00 00 00 00 00 00 03 00 00 |NINE............|
00000020 00 04 00 00 00 |.....|
00000025
]]></screen>
- </example>
- </para>
- <para>
- <example>
- <title>QuickHash IntString file format</title>
- <screen><![CDATA[
+ </example>
+ <example>
+ <title>QuickHash IntString file format</title>
+ <screen><![CDATA[
header signature ('QH'; key type: 1; value type: 2; filler: \0x00)
00000000 51 48 12 00
@@ -60,45 +56,42 @@ key/value 1 (key = 1, string index = 0 ("ONE")):
key/value 2 (key = 3, string index = 4 ("NINE")):
03 00 00 00 04 00 00 00
]]></screen>
- </example>
- </para>
+ </example>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The filename of the file to read the hash from.
- </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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The filename of the file to read the hash from.
+ </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 <literal>4</literal> to <literal>4194304</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -110,10 +103,9 @@ key/value 2 (key = 3, string index = 4 ("NINE")):
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::loadFromFile</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::loadFromFile</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$file = dirname( __FILE__ ) . "/simple.string.hash";
@@ -130,9 +122,9 @@ foreach( range( 0, 0x0f ) as $key )
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Key 0 ( 0) is unset
Key 1 ( 1) is set
@@ -151,14 +143,12 @@ Key 13 ( d) is set
Key 14 ( e) is unset
Key 15 ( f) is unset
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/loadfromstring.xml b/reference/quickhash/quickhashintstringhash/loadfromstring.xml
index 91de76072e5a..de5ba16b851a 100644
--- a/reference/quickhash/quickhashintstringhash/loadfromstring.xml
+++ b/reference/quickhash/quickhashintstringhash/loadfromstring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.loadfromstring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.loadfromstring">
<refnamediv>
<refname>QuickHashIntStringHash::loadFromString</refname>
<refpurpose>This factory method creates a hash from a string</refpurpose>
@@ -23,39 +22,37 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>contents</parameter></term>
- <listitem>
- <para>
- The string containing a serialized format of the hash.
- </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>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>contents</parameter></term>
+ <listitem>
+ <para>
+ The string containing a serialized format of the hash.
+ </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>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -67,10 +64,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::loadFromString</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::loadFromString</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$contents = file_get_contents( dirname( __FILE__ ) . "/simple.hash" );
@@ -87,9 +83,9 @@ foreach( range( 0, 0x0f ) as $key )
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Key 0 ( 0) is unset
Key 1 ( 1) is set
@@ -108,14 +104,12 @@ Key 13 ( d) is set
Key 14 ( e) is unset
Key 15 ( f) is unset
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/savetofile.xml b/reference/quickhash/quickhashintstringhash/savetofile.xml
index 3789fdf76336..93d0d14aa2b7 100644
--- a/reference/quickhash/quickhashintstringhash/savetofile.xml
+++ b/reference/quickhash/quickhashintstringhash/savetofile.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.savetofile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.savetofile">
<refnamediv>
<refname>QuickHashIntStringHash::saveToFile</refname>
<refpurpose>This method stores an in-memory hash to disk</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The filename of the file to store the hash in.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The filename of the file to store the hash in.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,10 +41,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::saveToFile</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::saveToFile</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntStringHash( 1024 );
@@ -59,14 +55,12 @@ var_dump( $hash->add( 4, "fifty two" ) );
$hash->saveToFile( '/tmp/test.string.hash' );
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/savetostring.xml b/reference/quickhash/quickhashintstringhash/savetostring.xml
index 1e5f2722d4d7..3b768d66e809 100644
--- a/reference/quickhash/quickhashintstringhash/savetostring.xml
+++ b/reference/quickhash/quickhashintstringhash/savetostring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.savetostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.savetostring">
<refnamediv>
<refname>QuickHashIntStringHash::saveToString</refname>
<refpurpose>This method returns a serialized version of the hash</refpurpose>
@@ -34,10 +33,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::saveToString</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::saveToString</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntStringHash( 1024 );
@@ -49,14 +47,12 @@ var_dump( $hash->add( 5, "fifty five" ) );
var_dump( $hash->saveToString() );
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/set.xml b/reference/quickhash/quickhashintstringhash/set.xml
index 5b4d9f45a9d4..88b6d37b29c0 100644
--- a/reference/quickhash/quickhashintstringhash/set.xml
+++ b/reference/quickhash/quickhashintstringhash/set.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.set">
<refnamediv>
<refname>QuickHashIntStringHash::set</refname>
<refpurpose>This method updates an entry in the hash with a new value, or
@@ -27,27 +26,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to add or update.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The value of the entry to add. If a non-string is passed, it will be
- converted to a string automatically if possible.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to add or update.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The value of the entry to add. If a non-string is passed, it will be
+ converted to a string automatically if possible.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -60,10 +57,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::set</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::set</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntStringHash( 1024 );
@@ -78,9 +74,9 @@ var_dump( $hash->set( 46692, "twenty nine thousand nine hundred six" ) );
var_dump( $hash->get( 46692 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Set->Add
bool(false)
@@ -90,14 +86,12 @@ Set->Update
int(1)
string(37) "twenty nine thousand nine hundred six"
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashintstringhash/update.xml b/reference/quickhash/quickhashintstringhash/update.xml
index 4433b75a02bc..5d1434422d83 100644
--- a/reference/quickhash/quickhashintstringhash/update.xml
+++ b/reference/quickhash/quickhashintstringhash/update.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashintstringhash.update" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintstringhash.update">
<refnamediv>
<refname>QuickHashIntStringHash::update</refname>
<refpurpose>This method updates an entry in the hash with a new value</refpurpose>
@@ -24,27 +23,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to update.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The new value for the entry. If a non-string is passed, it will be
- converted to a string automatically if possible.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to update.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The new value for the entry. If a non-string is passed, it will be
+ converted to a string automatically if possible.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -57,10 +54,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashIntStringHash::update</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashIntStringHash::update</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash->add( 161803398, "--" );
@@ -76,9 +72,9 @@ echo $hash->get( 161803398 ), "\n";
echo $hash->get( 314159265 ), "\n";
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
--
a lot
@@ -87,14 +83,12 @@ bool(false)
--
a lot plus one
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- 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 918afc7df559..e8bcf7c1e0d5 100644
--- a/reference/quickhash/quickhashstringinthash/add.xml
+++ b/reference/quickhash/quickhashstringinthash/add.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.add">
<refnamediv>
<refname>QuickHashStringIntHash::add</refname>
<refpurpose>This method adds a new entry to the hash</refpurpose>
@@ -23,26 +22,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to add.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The value of the entry to add.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to add.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The value of the entry to add.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,10 +51,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::add</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::add</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
echo "without dupe checking\n";
@@ -81,9 +77,9 @@ var_dump( $hash->get( "four" ) );
var_dump( $hash->add( "four", 9 ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
without dupe checking
object(QuickHashStringIntHash)#1 (0) {
@@ -105,14 +101,12 @@ bool(true)
int(78)
bool(false)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/construct.xml b/reference/quickhash/quickhashstringinthash/construct.xml
index d019605966ec..7e1c3424c9b4 100644
--- a/reference/quickhash/quickhashstringinthash/construct.xml
+++ b/reference/quickhash/quickhashstringinthash/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.construct">
<refnamediv>
<refname>QuickHashStringIntHash::__construct</refname>
<refpurpose>Creates a new QuickHashStringIntHash object</refpurpose>
@@ -23,32 +22,30 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <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 <literal>64</literal> to <literal>4194304</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <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 <literal>64</literal> to <literal>4194304</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -60,24 +57,21 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::__construct</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::__construct</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
var_dump( new QuickHashStringIntHash( 1024 ) );
var_dump( new QuickHashStringIntHash( 1024, QuickHashStringIntHash::CHECK_FOR_DUPES ) );
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/delete.xml b/reference/quickhash/quickhashstringinthash/delete.xml
index 4763e553fc02..76784b14ad50 100644
--- a/reference/quickhash/quickhashstringinthash/delete.xml
+++ b/reference/quickhash/quickhashstringinthash/delete.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.delete">
<refnamediv>
<refname>QuickHashStringIntHash::delete</refname>
<refpurpose>This method deletes an entry from the hash</refpurpose>
@@ -27,18 +26,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to delete.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to delete.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -50,10 +47,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::delete</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::delete</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashStringIntHash( 1024 );
@@ -66,9 +62,9 @@ var_dump( $hash->get( 'four' ) );
var_dump( $hash->delete( 'four' ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
bool(true)
@@ -78,14 +74,12 @@ bool(false)
bool(false)
bool(false)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/exists.xml b/reference/quickhash/quickhashstringinthash/exists.xml
index fd334454c44e..66701b93f778 100644
--- a/reference/quickhash/quickhashstringinthash/exists.xml
+++ b/reference/quickhash/quickhashstringinthash/exists.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.exists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.exists">
<refnamediv>
<refname>QuickHashStringIntHash::exists</refname>
<refpurpose>This method checks whether a key is part of the hash</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to check for whether it exists in the hash.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to check for whether it exists in the hash.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,7 +41,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/get.xml b/reference/quickhash/quickhashstringinthash/get.xml
index efb05c6ac2ac..ccb18bca6262 100644
--- a/reference/quickhash/quickhashstringinthash/get.xml
+++ b/reference/quickhash/quickhashstringinthash/get.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.get">
<refnamediv>
<refname>QuickHashStringIntHash::get</refname>
<refpurpose>This method retrieves a value from the hash by its key</refpurpose>
@@ -20,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to retrieve.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to retrieve.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,10 +40,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::get</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::get</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashStringIntHash( 8 );
@@ -56,22 +52,20 @@ var_dump( $hash->add( "two", 2 ) );
var_dump( $hash->get( "two" ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
bool(true)
int(2)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/getsize.xml b/reference/quickhash/quickhashstringinthash/getsize.xml
index e2144f76e383..14e03d17817e 100644
--- a/reference/quickhash/quickhashstringinthash/getsize.xml
+++ b/reference/quickhash/quickhashstringinthash/getsize.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.getsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.getsize">
<refnamediv>
<refname>QuickHashStringIntHash::getSize</refname>
<refpurpose>Returns the number of elements in the hash</refpurpose>
@@ -31,10 +30,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::getSize</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::getSize</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashStringIntHash( 8 );
@@ -43,22 +41,20 @@ var_dump( $hash->add( "three", 5 ) );
var_dump( $hash->getSize() );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(true)
bool(true)
int(2)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/loadfromfile.xml b/reference/quickhash/quickhashstringinthash/loadfromfile.xml
index 342d5814ae6a..aabe822717b7 100644
--- a/reference/quickhash/quickhashstringinthash/loadfromfile.xml
+++ b/reference/quickhash/quickhashstringinthash/loadfromfile.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.loadfromfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.loadfromfile">
<refnamediv>
<refname>QuickHashStringIntHash::loadFromFile</refname>
<refpurpose>This factory method creates a hash from a file</refpurpose>
@@ -30,20 +29,17 @@
into the string list containing the keys, and the second one the value. An
example could be:
</para>
- <para>
- <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!.........@...|
+ <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!.........@...|
00000010 4f 4e 45 00 4e 49 4e 45 00 07 00 00 00 01 00 00 |ONE.NINE........|
00000020 00 00 00 00 00 01 00 00 00 2f 00 00 00 01 00 00 |........./......|
00000030 00 04 00 00 00 03 00 00 00 |.........|
00000039]]></screen>
- </example>
- </para>
- <para>
- <example>
- <title>QuickHash IntHash file format</title>
- <screen><![CDATA[header signature ('QH'; key type: 2; value type: 1; filler: \0x00)
+ </example>
+ <example>
+ <title>QuickHash IntHash file format</title>
+ <screen><![CDATA[header signature ('QH'; key type: 2; value type: 1; filler: \0x00)
00000000 51 48 21 00
number of elements:
@@ -72,45 +68,42 @@ bucket lists:
04 00 00 00 03 00 00 00
]]></screen>
- </example>
- </para>
+ </example>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The filename of the file to read the hash from.
- </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 <literal>4</literal> to <literal>4194304</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The filename of the file to read the hash from.
+ </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 <literal>4</literal> to <literal>4194304</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -122,10 +115,9 @@ bucket lists:
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::loadFromFile</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::loadFromFile</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$file = dirname( __FILE__ ) . "/simple.hash.string";
@@ -141,9 +133,9 @@ foreach( range( 0, 0x0f ) as $key )
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
11l4 => 48712
12uf => 50343
@@ -162,14 +154,12 @@ foreach( range( 0, 0x0f ) as $key )
1j7e => 71546
1kgp => 73177
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/loadfromstring.xml b/reference/quickhash/quickhashstringinthash/loadfromstring.xml
index 731a6870d4aa..9524580fcf34 100644
--- a/reference/quickhash/quickhashstringinthash/loadfromstring.xml
+++ b/reference/quickhash/quickhashstringinthash/loadfromstring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.loadfromstring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.loadfromstring">
<refnamediv>
<refname>QuickHashStringIntHash::loadFromString</refname>
<refpurpose>This factory method creates a hash from a string</refpurpose>
@@ -23,39 +22,37 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>contents</parameter></term>
- <listitem>
- <para>
- The string containing a serialized format of the hash.
- </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>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>contents</parameter></term>
+ <listitem>
+ <para>
+ The string containing a serialized format of the hash.
+ </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>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -67,10 +64,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::loadFromString</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::loadFromString</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$contents = file_get_contents( dirname( __FILE__ ) . "/simple.hash.string" );
@@ -86,9 +82,9 @@ foreach( range( 0, 0x0f ) as $key )
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
11l4 => 48712
12uf => 50343
@@ -107,14 +103,12 @@ foreach( range( 0, 0x0f ) as $key )
1j7e => 71546
1kgp => 73177
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/savetofile.xml b/reference/quickhash/quickhashstringinthash/savetofile.xml
index 331efdeee2bf..94eb30719a42 100644
--- a/reference/quickhash/quickhashstringinthash/savetofile.xml
+++ b/reference/quickhash/quickhashstringinthash/savetofile.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.savetofile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.savetofile">
<refnamediv>
<refname>QuickHashStringIntHash::saveToFile</refname>
<refpurpose>This method stores an in-memory hash to disk</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The filename of the file to store the hash in.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The filename of the file to store the hash in.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,10 +41,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::saveToFile</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::saveToFile</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashStringIntHash( 1024 );
@@ -57,14 +53,12 @@ var_dump( $hash->add( "fifty two", 52 ) );
$hash->saveToFile( '/tmp/test.hash.string' );
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/savetostring.xml b/reference/quickhash/quickhashstringinthash/savetostring.xml
index a78c37170c4e..4cc25916088f 100644
--- a/reference/quickhash/quickhashstringinthash/savetostring.xml
+++ b/reference/quickhash/quickhashstringinthash/savetostring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.savetostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.savetostring">
<refnamediv>
<refname>QuickHashStringIntHash::saveToString</refname>
<refpurpose>This method returns a serialized version of the hash</refpurpose>
@@ -33,10 +32,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::saveToString</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::saveToString</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashStringIntHash( 1024 );
@@ -46,14 +44,12 @@ var_dump( $hash->add( "fifty two", 52 ) );
var_dump( $hash->saveToString() );
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/set.xml b/reference/quickhash/quickhashstringinthash/set.xml
index 00795add42cd..013c008ddd8d 100644
--- a/reference/quickhash/quickhashstringinthash/set.xml
+++ b/reference/quickhash/quickhashstringinthash/set.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.set">
<refnamediv>
<refname>QuickHashStringIntHash::set</refname>
<refpurpose>This method updates an entry in the hash with a new value, or
@@ -27,27 +26,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to add or update.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The value of the entry to add. If a non-string is passed, it will be
- converted to a string automatically if possible.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to add or update.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The value of the entry to add. If a non-string is passed, it will be
+ converted to a string automatically if possible.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -60,10 +57,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::set</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::set</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashStringIntHash( 1024 );
@@ -78,9 +74,9 @@ var_dump( $hash->set( "forty six thousand six hundred ninety two", 29906 ) );
var_dump( $hash->get( "forty six thousand six hundred ninety two" ) );
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Set->Add
bool(false)
@@ -90,14 +86,12 @@ Set->Update
int(1)
int(29906)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/quickhash/quickhashstringinthash/update.xml b/reference/quickhash/quickhashstringinthash/update.xml
index b37931bf6a93..a4591f9a6557 100644
--- a/reference/quickhash/quickhashstringinthash/update.xml
+++ b/reference/quickhash/quickhashstringinthash/update.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="quickhashstringinthash.update" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.update">
<refnamediv>
<refname>QuickHashStringIntHash::update</refname>
<refpurpose>This method updates an entry in the hash with a new value</refpurpose>
@@ -24,27 +23,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The key of the entry to update.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The new value for the entry. If a non-string is passed, it will be
- converted to a string automatically if possible.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key of the entry to update.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The new value for the entry. If a non-string is passed, it will be
+ converted to a string automatically if possible.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -57,10 +54,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>QuickHashStringIntHash::update</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>QuickHashStringIntHash::update</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashStringIntHash( 1024 );
@@ -78,9 +74,9 @@ echo $hash->get( 'six' ), "\n";
echo $hash->get( 'a lot' ), "\n";
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
314159265
314159265
@@ -89,14 +85,12 @@ bool(false)
314159265
314159266
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml