From 2d9bcb1156e55b1d65e22a4a31fb67fb6d48f80e Mon Sep 17 00:00:00 2001
From: Derick Rethans <github@derickrethans.nl>
Date: Wed, 27 Jul 2011 17:05:02 +0100
Subject: [PATCH] Fixed documentation so that it builds properly.

---
 docs/book.xml                                |  5 ++++-
 docs/quickhashinthash/getsize.xml            |  2 +-
 docs/quickhashinthash/loadfromfile.xml       | 15 ++++++++++-----
 docs/quickhashinthash/savetostring.xml       | 10 +---------
 docs/quickhashintset/getsize.xml             |  2 +-
 docs/quickhashintset/savetostring.xml        | 10 +---------
 docs/quickhashintstringhash/getsize.xml      | 18 +-----------------
 docs/quickhashintstringhash/loadfromfile.xml | 14 ++++++++++----
 docs/quickhashintstringhash/savetostring.xml | 10 +---------
 docs/quickhashstringinthash/getsize.xml      |  2 +-
 docs/quickhashstringinthash/loadfromfile.xml | 15 ++++++++++-----
 docs/quickhashstringinthash/savetostring.xml | 10 +---------
 docs/setup.xml                               | 12 ++++--------
 13 files changed, 46 insertions(+), 79 deletions(-)

diff --git a/docs/book.xml b/docs/book.xml
index 5296c37..cd45b69 100644
--- a/docs/book.xml
+++ b/docs/book.xml
@@ -16,8 +16,11 @@
  &reference.quickhash.setup;
  &reference.quickhash.constants;
  &reference.quickhash.examples;
- &reference.quickhash.reference;
 
+ &reference.quickhash.quickhashintset;
+ &reference.quickhash.quickhashinthash;
+ &reference.quickhash.quickhashstringinthash;
+ &reference.quickhash.quickhashintstringhash;
 </book>
 
 <!-- Keep this comment at the end of the file
diff --git a/docs/quickhashinthash/getsize.xml b/docs/quickhashinthash/getsize.xml
index 630f644..9457a6a 100644
--- a/docs/quickhashinthash/getsize.xml
+++ b/docs/quickhashinthash/getsize.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>integer</type><methodname>QuickHashIntHash::getSize</methodname>
+   <modifier>public</modifier> <type>integer</type><methodname>QuickHashIntHash::getSize</methodname><void/>
   </methodsynopsis>
   <para>
    Returns the number of elements in the hash.
diff --git a/docs/quickhashinthash/loadfromfile.xml b/docs/quickhashinthash/loadfromfile.xml
index b8e1cee..081d6b8 100644
--- a/docs/quickhashinthash/loadfromfile.xml
+++ b/docs/quickhashinthash/loadfromfile.xml
@@ -24,14 +24,18 @@
    belonging to the key. An example could be:
   </para>
   <para>
-   <example><![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
-]]></example>
+]]></screen>
+   </example>
   </para>
   <para>
-   <example><![CDATA[
-header signature ('QH'; key type: 1; value type: 1; filler: \0x00)
+   <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:
@@ -45,7 +49,8 @@ key/value 1 (key = 1, value = 1)
 
 key/value 2 (key = 3, value = 9)
 03 00 00 00  09 00 00 00
-]]></example>
+]]></screen>
+   </example>
   </para>
 
  </refsect1>
diff --git a/docs/quickhashinthash/savetostring.xml b/docs/quickhashinthash/savetostring.xml
index af4a4bd..b8e6290 100644
--- a/docs/quickhashinthash/savetostring.xml
+++ b/docs/quickhashinthash/savetostring.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>QuickHashIntHash::saveToFile</methodname>
+   <modifier>public</modifier> <type>string</type><methodname>QuickHashIntHash::saveToString</methodname><void/>
   </methodsynopsis>
   <para>
    This method returns a serialized version of the hash in the same format that
@@ -18,14 +18,6 @@
   </para>
  </refsect1>
 
- <refsect1 role="parameters">
-  &reftitle.parameters;
-  <para>
-   <variablelist>
-   </variablelist>
-  </para>
- </refsect1>
-
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
diff --git a/docs/quickhashintset/getsize.xml b/docs/quickhashintset/getsize.xml
index 637ad20..c468325 100644
--- a/docs/quickhashintset/getsize.xml
+++ b/docs/quickhashintset/getsize.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>integer</type><methodname>QuickHashIntSet::getSize</methodname>
+   <modifier>public</modifier><type>integer</type><methodname>QuickHashIntSet::getSize</methodname><void/>
   </methodsynopsis>
   <para>
    Returns the number of elements in the set.
diff --git a/docs/quickhashintset/savetostring.xml b/docs/quickhashintset/savetostring.xml
index 18fcd56..a1aeb90 100644
--- a/docs/quickhashintset/savetostring.xml
+++ b/docs/quickhashintset/savetostring.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>QuickHashIntSet::saveToFile</methodname>
+   <modifier>public</modifier> <type>string</type><methodname>QuickHashIntSet::saveToString</methodname><void/>
   </methodsynopsis>
   <para>
    This method returns a serialized version of the set in the same format that
@@ -18,14 +18,6 @@
   </para>
  </refsect1>
 
- <refsect1 role="parameters">
-  &reftitle.parameters;
-  <para>
-   <variablelist>
-   </variablelist>
-  </para>
- </refsect1>
-
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
diff --git a/docs/quickhashintstringhash/getsize.xml b/docs/quickhashintstringhash/getsize.xml
index 4c73b31..dfbfcec 100644
--- a/docs/quickhashintstringhash/getsize.xml
+++ b/docs/quickhashintstringhash/getsize.xml
@@ -10,29 +10,13 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>integer</type><methodname>QuickHashIntStringHash::getSize</methodname>
+   <modifier>public</modifier> <type>integer</type><methodname>QuickHashIntStringHash::getSize</methodname><void/>
   </methodsynopsis>
   <para>
    Returns the number of elements in the hash.
   </para>
  </refsect1>
 
- <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>
- </refsect1>
-
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
diff --git a/docs/quickhashintstringhash/loadfromfile.xml b/docs/quickhashintstringhash/loadfromfile.xml
index 043e61b..0bf9b8e 100644
--- a/docs/quickhashintstringhash/loadfromfile.xml
+++ b/docs/quickhashintstringhash/loadfromfile.xml
@@ -25,14 +25,19 @@
    string. An example could be:
   </para>
   <para>
-   <example><![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
-]]></example>
+]]></screen>
+   </example>
   </para>
   <para>
-   <example><![CDATA[
+   <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
 
@@ -53,7 +58,8 @@ 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
-]]></example>
+]]></screen>
+   </example>
   </para>
  </refsect1>
 
diff --git a/docs/quickhashintstringhash/savetostring.xml b/docs/quickhashintstringhash/savetostring.xml
index 2d9fdaf..8aea341 100644
--- a/docs/quickhashintstringhash/savetostring.xml
+++ b/docs/quickhashintstringhash/savetostring.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>QuickHashIntStringHash::saveToFile</methodname>
+   <modifier>public</modifier> <type>string</type><methodname>QuickHashIntStringHash::saveToStringe</methodname><void/>
   </methodsynopsis>
   <para>
    This method returns a serialized version of the hash in the same format that
@@ -18,14 +18,6 @@
   </para>
  </refsect1>
 
- <refsect1 role="parameters">
-  &reftitle.parameters;
-  <para>
-   <variablelist>
-   </variablelist>
-  </para>
- </refsect1>
-
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
diff --git a/docs/quickhashstringinthash/getsize.xml b/docs/quickhashstringinthash/getsize.xml
index 21defab..a05cce4 100644
--- a/docs/quickhashstringinthash/getsize.xml
+++ b/docs/quickhashstringinthash/getsize.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>integer</type><methodname>QuickHashStringIntHash::getSize</methodname>
+   <modifier>public</modifier> <type>integer</type><methodname>QuickHashStringIntHash::getSize</methodname><void/>
   </methodsynopsis>
   <para>
    Returns the number of elements in the hash.
diff --git a/docs/quickhashstringinthash/loadfromfile.xml b/docs/quickhashstringinthash/loadfromfile.xml
index fefd62a..de008da 100644
--- a/docs/quickhashstringinthash/loadfromfile.xml
+++ b/docs/quickhashstringinthash/loadfromfile.xml
@@ -30,15 +30,19 @@
    example could be:
   </para>
   <para>
-   <example><![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[<![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]]></example>
+00000039]]></screen>
+   </example>
   </para>
   <para>
-   <example><![CDATA[
-header signature ('QH'; key type: 2; value type: 1; filler: \0x00)
+   <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:
@@ -66,7 +70,8 @@ bucket lists:
     elements (key index: 4 ('NINE'), value = 3):
     04 00 00 00 03 00 00 00
 
-]]></example>
+]]></screen>
+   </example>
   </para>
  </refsect1>
 
diff --git a/docs/quickhashstringinthash/savetostring.xml b/docs/quickhashstringinthash/savetostring.xml
index 121f6ab..be6581b 100644
--- a/docs/quickhashstringinthash/savetostring.xml
+++ b/docs/quickhashstringinthash/savetostring.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>QuickHashStringIntHash::saveToFile</methodname>
+   <modifier>public</modifier> <type>string</type><methodname>QuickHashStringIntHash::saveToString</methodname><void/>
   </methodsynopsis>
   <para>
    This method returns a serialized version of the hash in the same format that
@@ -18,14 +18,6 @@
   </para>
  </refsect1>
 
- <refsect1 role="parameters">
-  &reftitle.parameters;
-  <para>
-   <variablelist>
-   </variablelist>
-  </para>
- </refsect1>
-
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
diff --git a/docs/setup.xml b/docs/setup.xml
index 2215812..4c31a63 100644
--- a/docs/setup.xml
+++ b/docs/setup.xml
@@ -13,7 +13,10 @@
 
  <section xml:id="quickhash.installation">
   &reftitle.install;
-  &no.install;
+  <para>
+   &pecl.info;
+   <link xlink:href="&url.pecl.package;quickhash">&url.pecl.package;quickhash</link>
+  </para>
  </section>
 
  <section xml:id="quickhash.configuration">
@@ -21,13 +24,6 @@
   &no.config;
  </section>
 
- <section xml:id="quickhash.resources">
-  &reftitle.resources;
-  <para>
-
-  </para>
- </section>
-
 </chapter>
 
 <!-- Keep this comment at the end of the file