This is an automated email from the ASF dual-hosted git repository.
mattjuntunen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-geometry.git
The following commit(s) were added to refs/heads/master by this push:
new 5b280dc adding example module section to userguide
5b280dc is described below
commit 5b280dcb0d8ec4e71bc7002c9ea4b6c3348a3b8e
Author: Matt Juntunen <mattjuntu...@apache.org>
AuthorDate: Wed Aug 11 22:44:21 2021 -0400
adding example module section to userguide
---
src/site/site.xml | 1 +
src/site/xdoc/tutorials/bsp-tree.xml | 7 ++++---
src/site/xdoc/tutorials/teapot.xml | 5 +++--
src/site/xdoc/userguide/index.xml | 14 ++++++++++++++
4 files changed, 22 insertions(+), 5 deletions(-)
diff --git a/src/site/site.xml b/src/site/site.xml
index 1bb3df5..2e99eff 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -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"/>
diff --git a/src/site/xdoc/tutorials/bsp-tree.xml
b/src/site/xdoc/tutorials/bsp-tree.xml
index 00b1871..868994a 100644
--- a/src/site/xdoc/tutorials/bsp-tree.xml
+++ b/src/site/xdoc/tutorials/bsp-tree.xml
@@ -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>
diff --git a/src/site/xdoc/tutorials/teapot.xml
b/src/site/xdoc/tutorials/teapot.xml
index 86e6b85..9028547 100644
--- a/src/site/xdoc/tutorials/teapot.xml
+++ b/src/site/xdoc/tutorials/teapot.xml
@@ -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>
diff --git a/src/site/xdoc/userguide/index.xml
b/src/site/xdoc/userguide/index.xml
index 4e2f93a..fdfc9c7 100644
--- a/src/site/xdoc/userguide/index.xml
+++ b/src/site/xdoc/userguide/index.xml
@@ -32,6 +32,9 @@
<a href="#overview">Overview</a>
</li>
<li>
+ <a href="#example-modules">Example Modules</a>
+ </li>
+ <li>
<a href="#concepts">Concepts</a>
<ul>
<li>
@@ -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>
