Author: luc
Date: Wed Jan 22 12:39:14 2014
New Revision: 1560336
URL: http://svn.apache.org/r1560336
Log:
improved javadoc
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java?rev=1560336&r1=1560335&r2=1560336&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java
Wed Jan 22 12:39:14 2014
@@ -21,9 +21,10 @@ import org.apache.commons.math3.geometry
/** 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.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java?rev=1560336&r1=1560335&r2=1560336&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
Wed Jan 22 12:39:14 2014
@@ -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
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java?rev=1560336&r1=1560335&r2=1560336&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java
Wed Jan 22 12:39:14 2014
@@ -889,8 +889,8 @@ public class ArcsSet extends AbstractReg
/** 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 {