Skip to content
This repository has been archived by the owner on May 27, 2020. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
g-andrade committed Apr 23, 2016
1 parent 191897d commit 7229aad
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 6 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ __Authors:__ Guilherme Andrade ([`erlquad(at)gandrade(dot)net`](mailto:erlquad(a

`erlquad` is a straightforward Erlang implementation of [quadtrees](https://en.wikipedia.org/wiki/Quadtree), supporting both bounding-box outlines as well as precise coordinates for small enough objects.

It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. 'Deeplist' versions of fetching methods are also included for when there's no need to concatenate the final results and thus avoid the overhead of doing so.
It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. Deeplist versions of fetching methods are also included for when there's no need to concatenate the intermediate results and thus avoid the overhead of doing so.

Buckets have unlimited capacity and depth is fixed on initialization.

```erlang

Expand Down
2 changes: 1 addition & 1 deletion doc/erlquad.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,6 @@ <h3 class="function"><a name="objects_fold-3">objects_fold/3</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Apr 23 2016, 21:49:36.</i></p>
<p><i>Generated by EDoc, Apr 23 2016, 21:57:16.</i></p>
</body>
</html>
6 changes: 4 additions & 2 deletions doc/overview-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ <h1>erlquad</h1>

<p><code>erlquad</code> is a straightforward Erlang implementation of <a href="https://en.wikipedia.org/wiki/Quadtree">quadtrees</a>, supporting both bounding-box outlines as well as precise coordinates for small enough objects.</p>

<p>It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. 'Deeplist' versions of fetching methods are also included for when there's no need to concatenate the final results and thus avoid the overhead of doing so.</p>
<p>It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. Deeplist versions of fetching methods are also included for when there's no need to concatenate the intermediate results and thus avoid the overhead of doing so.</p>

<p>Buckets have unlimited capacity and depth is fixed on initialization.</p>

<pre lang="erlang">
Object1 = #big_square{ x = 1000, y = 750, side = 10 },
Expand Down Expand Up @@ -67,6 +69,6 @@ <h1>erlquad</h1>

<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Apr 23 2016, 21:49:36.</i></p>
<p><i>Generated by EDoc, Apr 23 2016, 21:57:16.</i></p>
</body>
</html>
4 changes: 3 additions & 1 deletion doc/overview.edoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@

`erlquad' is a straightforward Erlang implementation of <a href="https://en.wikipedia.org/wiki/Quadtree">quadtrees</a>, supporting both bounding-box outlines as well as precise coordinates for small enough objects.

It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. 'Deeplist' versions of fetching methods are also included for when there's no need to concatenate the final results and thus avoid the overhead of doing so.
It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. Deeplist versions of fetching methods are also included for when there's no need to concatenate the intermediate results and thus avoid the overhead of doing so.

Buckets have unlimited capacity and depth is fixed on initialization.

<pre lang="erlang">
Object1 = #big_square{ x = 1000, y = 750, side = 10 },
Expand Down
4 changes: 3 additions & 1 deletion doc/utf8/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ __Authors:__ Guilherme Andrade ([`erlquad(at)gandrade(dot)net`](mailto:erlquad(a

`erlquad` is a straightforward Erlang implementation of [quadtrees](https://en.wikipedia.org/wiki/Quadtree), supporting both bounding-box outlines as well as precise coordinates for small enough objects.

It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. 'Deeplist' versions of fetching methods are also included for when there's no need to concatenate the final results and thus avoid the overhead of doing so.
It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. Deeplist versions of fetching methods are also included for when there's no need to concatenate the intermediate results and thus avoid the overhead of doing so.

Buckets have unlimited capacity and depth is fixed on initialization.

```erlang

Expand Down

0 comments on commit 7229aad

Please sign in to comment.