Skip to content
Permalink
Browse files
adding example module section to userguide
  • Loading branch information
darkma773r committed Aug 12, 2021
1 parent 224ea78 commit 5b280dcb0d8ec4e71bc7002c9ea4b6c3348a3b8e
Showing 4 changed files with 22 additions and 5 deletions.
@@ -71,6 +71,7 @@
<menu name="User Guide">
<item name="Contents" href="/userguide/index.html#toc"/>
<item name="Overview" href="/userguide/index.html#overview"/>
<item name="Example Modules" href="/userguide/index.html#example-modules"/>
<item name="Concepts" href="/userguide/index.html#concepts"/>
<item name="Core Interfaces" href="/userguide/index.html#interfaces"/>
<item name="Euclidean Space" href="/userguide/index.html#euclidean"/>
@@ -50,9 +50,10 @@
<p>
This tutorial gives a brief introduction to the
<a target="_blank" href="https://en.wikipedia.org/wiki/Binary_space_partitioning">BSP tree</a> data structure and its use in
<em>Commons Geometry.</em> All sample code in this tutorial can be found in the
<a class="code" href="../commons-geometry-examples/commons-geometry-examples-tutorials/apidocs/org/apache/commons/geometry/examples/tutorials/bsp/package-summary.html"
>org.apache.commons.geometry.examples.tutorials.bsp</a> package.
<em>Commons Geometry.</em> All code in this tutorial can be found in the
<a class="code" href="../commons-geometry-examples/commons-geometry-examples-tutorials/xref/org/apache/commons/geometry/examples/tutorials/bsp/package-summary.html"
>org.apache.commons.geometry.examples.tutorials.bsp</a> package, which is included in the library
<a href="https://commons.apache.org/geometry/download_geometry.cgi">source distribution</a>.
</p>
</section>

@@ -59,8 +59,9 @@
These geometric figures can be combined in various ways to produce new figures. In this tutorial,
we will explore these features by constructing a 3D model of a teapot from scratch. The image
below shows the result of our efforts. The final code for this tutorial can be found in the
<a class="code" href="../commons-geometry-examples/commons-geometry-examples-tutorials/apidocs/org/apache/commons/geometry/examples/tutorials/teapot/TeapotBuilder.html">
TeapotBuilder</a> class.
<a class="code" href="../commons-geometry-examples/commons-geometry-examples-tutorials/xref/org/apache/commons/geometry/examples/tutorials/teapot/TeapotBuilder.html">
TeapotBuilder</a> class, which is included in the library
<a href="https://commons.apache.org/geometry/download_geometry.cgi">source distribution</a>.
</p>

<p>
@@ -31,6 +31,9 @@
<li>
<a href="#overview">Overview</a>
</li>
<li>
<a href="#example-modules">Example Modules</a>
</li>
<li>
<a href="#concepts">Concepts</a>
<ul>
@@ -134,6 +137,17 @@
</ul>
</section>

<section name="Example Modules" id="example-modules">
<p>
In addition to the modules above, the <em>Commons Geometry</em>
<a href="https://commons.apache.org/geometry/download_geometry.cgi">source distribution</a> contains example
code demonstrating library functionality and/or providing useful development utilities. These modules are not
part of the public API of the library and no guarantees are made concerning backwards compatibility. The
<a href="../commons-geometry-examples/modules.html">example module parent page</a> contains a listing of the
available modules.
</p>
</section>

<section name="Concepts" id="concepts">
<subsection name="Floating Point Math" id="floating_point">
<p>

0 comments on commit 5b280dc

Please sign in to comment.