Skip to content

Commit

Permalink
Fixed documentation so that it builds properly.
Browse files Browse the repository at this point in the history
  • Loading branch information
@derickr
derickr committed Jul 27, 2011
1 parent 1e37c7a commit 2d9bcb1
Show file tree
Hide file tree
Showing 13 changed files with 46 additions and 79 deletions.
5 changes: 4 additions & 1 deletion docs/book.xml
View file
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/quickhashinthash/getsize.xml
View file
Expand Up @@ -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.
Expand Down
15 changes: 10 additions & 5 deletions docs/quickhashinthash/loadfromfile.xml
View file
Expand Up @@ -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:
Expand All @@ -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>
Expand Down
10 changes: 1 addition & 9 deletions docs/quickhashinthash/savetostring.xml
View file
Expand Up @@ -10,22 +10,14 @@
<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
loadFromString() can read.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
</variablelist>
</para>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Expand Down
2 changes: 1 addition & 1 deletion docs/quickhashintset/getsize.xml
View file
Expand Up @@ -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.
Expand Down
10 changes: 1 addition & 9 deletions docs/quickhashintset/savetostring.xml
View file
Expand Up @@ -10,22 +10,14 @@
<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
loadFromString() can read.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
</variablelist>
</para>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Expand Down
18 changes: 1 addition & 17 deletions docs/quickhashintstringhash/getsize.xml
View file
Expand Up @@ -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>
Expand Down
14 changes: 10 additions & 4 deletions docs/quickhashintstringhash/loadfromfile.xml
View file
Expand Up @@ -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
Expand All @@ -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>

Expand Down
10 changes: 1 addition & 9 deletions docs/quickhashintstringhash/savetostring.xml
View file
Expand Up @@ -10,22 +10,14 @@
<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
loadFromString() can read.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
</variablelist>
</para>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Expand Down
2 changes: 1 addition & 1 deletion docs/quickhashstringinthash/getsize.xml
View file
Expand Up @@ -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.
Expand Down
15 changes: 10 additions & 5 deletions docs/quickhashstringinthash/loadfromfile.xml
View file
Expand Up @@ -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:
Expand Down Expand Up @@ -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>

Expand Down
10 changes: 1 addition & 9 deletions docs/quickhashstringinthash/savetostring.xml
View file
Expand Up @@ -10,22 +10,14 @@
<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
loadFromString() can read.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
</variablelist>
</para>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Expand Down
12 changes: 4 additions & 8 deletions docs/setup.xml
View file
Expand Up @@ -13,21 +13,17 @@

<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">
&reftitle.runtime;
&no.config;
</section>

<section xml:id="quickhash.resources">
&reftitle.resources;
<para>

</para>
</section>

</chapter>

<!-- Keep this comment at the end of the file
Expand Down

0 comments on commit 2d9bcb1

Please sign in to comment.