From 1fc112d0536c7ee83d099d82a5b795561f7fd816 Mon Sep 17 00:00:00 2001
From: Luc Maisonobe <luc@apache.org>
Date: Wed, 22 Jan 2014 12:39:14 +0000
Subject: [PATCH] improved javadoc

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1560336 13f79535-47bb-0310-9956-ffa450edef68
---
 .../math3/geometry/partitioning/BoundaryAttribute.java    | 7 ++++---
 .../commons/math3/geometry/partitioning/Region.java       | 8 ++++----
 .../commons/math3/geometry/spherical/oned/ArcsSet.java    | 4 ++--
 3 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java b/src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java
index 4f93e2be5..cf192e192 100644
--- a/src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java
+++ b/src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java
@@ -21,9 +21,10 @@ import org.apache.commons.math3.geometry.Space;
 /** Class holding boundary attributes.
  * <p>This class is used for the attributes associated with the
  * nodes of region boundary shell trees returned by the {@link
- * Region#getTree Region.getTree}. It contains the
- * parts of the node cut sub-hyperplane that belong to the
- * boundary.</p>
+ * Region#getTree(boolean) Region.getTree(includeBoundaryAttributes)}
+ * when the boolean {@code includeBoundaryAttributes} parameter is
+ * set to {@code true}. It contains the parts of the node cut
+ * sub-hyperplane that belong to the boundary.</p>
  * <p>This class is a simple placeholder, it does not provide any
  * processing methods.</p>
  * @param <S> Type of the space.
diff --git a/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java b/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
index 0b07c252d..e7c8689ed 100644
--- a/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
+++ b/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
@@ -136,10 +136,10 @@ public interface Region<S extends Space> {
      * all internal nodes are guaranteed to have non-null
      * attributes, however some {@link BoundaryAttribute
      * BoundaryAttribute} instances may have their {@link
-     * BoundaryAttribute#plusInside plusInside} and {@link
-     * BoundaryAttribute#plusOutside plusOutside} fields both null if
-     * the corresponding cut sub-hyperplane does not have any parts
-     * belonging to the boundary.</p>
+     * BoundaryAttribute#getPlusInside() getPlusInside} and {@link
+     * BoundaryAttribute#getPlusOutside() getPlusOutside} methods both
+     * returning null if the corresponding cut sub-hyperplane does not
+     * have any parts belonging to the boundary.</p>
 
      * <p>Since computing the boundary is not always required and can be
      * time-consuming for large trees, these internal nodes attributes
diff --git a/src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java b/src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java
index e2389eb07..06a8bb2ec 100644
--- a/src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java
+++ b/src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java
@@ -889,8 +889,8 @@ public class ArcsSet extends AbstractRegion<Sphere1D, Sphere1D> implements Itera
     /** Specialized exception for inconsistent BSP tree state inconsistency.
      * <p>
      * This exception is thrown at {@link ArcsSet} construction time when the
-     * {@link Location inside/outside} state is not consistent at the 0,
-     * \(2 \pi \) crossing.
+     * {@link org.apache.commons.math3.geometry.partitioning.Region.Location inside/outside}
+     * state is not consistent at the 0, \(2 \pi \) crossing.
      * </p>
      */
     public static class InconsistentStateAt2PiWrapping extends MathIllegalArgumentException {