Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix JavaDoc issues #45

Merged
merged 1 commit into from
Dec 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
283 changes: 169 additions & 114 deletions src/main/java/eu/mihosoft/vrl/v3d/CSG.java

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/main/java/eu/mihosoft/vrl/v3d/ChamferedCylinder.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ public PropertyStorage getProperties() {
* Constructor. Creates a new cuboid with center {@code [0,0,0]} and with the specified
* dimensions.
*
* @param w width
* @param r radius
* @param h height
* @param d depth
* @param chamferHeight the chamfer height
*/
public ChamferedCylinder(double r, double h, double chamferHeight) {
this.r = r;
Expand Down
4 changes: 1 addition & 3 deletions src/main/java/eu/mihosoft/vrl/v3d/Dodecahedron.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
import java.util.List;

import eu.mihosoft.vrl.v3d.ext.quickhull3d.HullUtil;
import eu.mihosoft.vrl.v3d.parametrics.LengthParameter;
import eu.mihosoft.vrl.v3d.parametrics.Parameter;

public class Dodecahedron extends Primitive {

Expand Down Expand Up @@ -51,7 +49,7 @@ public Dodecahedron(double size) {
* radius.
*
* @param center center of the dodecahedron
* @param circumradius of the dodecahedron
* @param size of the dodecahedron
*/
public Dodecahedron(Vector3d center, double size) {
this.center = center;
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/eu/mihosoft/vrl/v3d/Edge.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
import java.util.stream.Stream;
import eu.mihosoft.vrl.v3d.ext.org.poly2tri.PolygonUtil;

// TODO: Auto-generated Javadoc
/**
* The Class Edge.
*
Expand Down Expand Up @@ -526,7 +525,6 @@ public static List<Polygon> _toPolygons(List<Edge> boundaryEdges, Plane plane) {
* Determines whether the specified point is colinear
*
* @param p point to check
* @param TOL tolerance
* @return <code>true</code> if the specified point lies on this line
* segment; <code>false</code> otherwise
*/
Expand Down
1 change: 0 additions & 1 deletion src/main/java/eu/mihosoft/vrl/v3d/Fillet.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ public PropertyStorage getProperties() {
*
* @param w width
* @param h height
* @param d depth
*/
public Fillet(double w, double h) {
this.w = w;
Expand Down
6 changes: 2 additions & 4 deletions src/main/java/eu/mihosoft/vrl/v3d/Icosahedron.java
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Icosahedron.java
*/
package eu.mihosoft.vrl.v3d;
Expand All @@ -7,8 +7,6 @@
import java.util.List;

import eu.mihosoft.vrl.v3d.ext.quickhull3d.HullUtil;
import eu.mihosoft.vrl.v3d.parametrics.LengthParameter;
import eu.mihosoft.vrl.v3d.parametrics.Parameter;

public class Icosahedron extends Primitive {

Expand Down Expand Up @@ -51,7 +49,7 @@ public Icosahedron(double size) {
* radius.
*
* @param center center of the icosahedron
* @param circumradius of the icosahedron
* @param size of the icosahedron
*/
public Icosahedron(Vector3d center, double size) {
this.center = center;
Expand Down
6 changes: 2 additions & 4 deletions src/main/java/eu/mihosoft/vrl/v3d/Octahedron.java
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Octahedron.java
*/
package eu.mihosoft.vrl.v3d;
Expand All @@ -7,8 +7,6 @@
import java.util.List;

import eu.mihosoft.vrl.v3d.ext.quickhull3d.HullUtil;
import eu.mihosoft.vrl.v3d.parametrics.LengthParameter;
import eu.mihosoft.vrl.v3d.parametrics.Parameter;

public class Octahedron extends Primitive {

Expand Down Expand Up @@ -51,7 +49,7 @@ public Octahedron(double size) {
* radius.
*
* @param center center of the octahedron
* @param circumradius of the octahedron
* @param size of the octahedron
*/
public Octahedron(Vector3d center, double size) {
this.center = center;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/eu/mihosoft/vrl/v3d/Tetrahedron.java
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Tetrahedron.java
*/
package eu.mihosoft.vrl.v3d;
Expand Down Expand Up @@ -51,7 +51,7 @@ public Tetrahedron(double size) {
* radius.
*
* @param center center of the tetrahedron
* @param circumradius of the tetrahedron
* @param size of the tetrahedron
*/
public Tetrahedron(Vector3d center, double size) {
this.center = center;
Expand Down
10 changes: 3 additions & 7 deletions src/main/java/eu/mihosoft/vrl/v3d/Toroid.java
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Cylinder.java
*
* Copyright 2014-2014 Michael Hoffer info@michaelhoffer.de. All rights
Expand Down Expand Up @@ -37,14 +37,10 @@
import java.util.Arrays;
import java.util.List;

import eu.mihosoft.vrl.v3d.ext.org.poly2tri.PolygonUtil;
import eu.mihosoft.vrl.v3d.parametrics.LengthParameter;

// TODO: Auto-generated Javadoc
/**
* A solid cylinder.
*
* The tessellation can be controlled via the {@link #numSlices} parameter.
* <p>
* The tessellation can be controlled via the numSlices parameter.
*
* @author Michael Hoffer &lt;info@michaelhoffer.de&gt;
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,44 +52,44 @@
* and doesn't permit null s. In addition to implementing the List interface, this class provides
* methods to manipulate the size of the array that is used internally to store the list. (This class is roughly
* equivalent to Vector , except that it is unsynchronized.)
*
* <p>
* The size , isEmpty , get , set , iterator , and listIterator
* operations run in constant time. The add operation runs in amortized constant time , that is, adding
* n elements requires O(n) time. All of the other operations run in linear time (roughly speaking). The constant
* factor is low compared to that for the LinkedList implementation.
*
* <p>
* Each ArrayList instance has a capacity . The capacity is the size of the array used to store the
* elements in the list. It is always at least as large as the list size. As elements are added to an ArrayList, its
* capacity grows automatically. The details of the growth policy are not specified beyond the fact that adding an
* element has constant amortized time cost.
*
* <p>
* An application can increase the capacity of an ArrayList instance before adding a large number of
* elements using the ensureCapacity operation. This may reduce the amount of incremental reallocation.
*
* <p>
* Note that this implementation is not synchronized. If multiple threads access an
* ArrayList instance concurrently, and at least one of the threads modifies the list structurally, it
* must be synchronized externally. (A structural modification is any operation that adds or deletes one or more
* elements, or explicitly resizes the backing array; merely setting the value of an element is not a structural
* modification.) This is typically accomplished by synchronizing on some object that naturally encapsulates the list.
*
* <p>
* If no such object exists, the list should be "wrapped" using the {@link Collections#synchronizedList
* Collections.synchronizedList} method. This is best done at creation time, to prevent accidental
* unsynchronized access to the list:
* List list = Collections.synchronizedList(new ArrayList(...));
*
* <p>
* name="fail-fast" The iterators returned by this class's {@link #iterator() iterator} and {@link
* #listIterator(int) listIterator} methods are fail-fast : if the list is structurally modified at any time
* after the iterator is created, in any way except through the iterator's own {@link ListIterator#remove() remove} or
* {@link ListIterator#add(Object) add} methods, the iterator will throw a {@link ConcurrentModificationException}.
* Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary,
* non-deterministic behavior at an undetermined time in the future.
*
* <p>
* Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to
* make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw {@code
* ConcurrentModificationException} on a best-effort basis. Therefore, it would be wrong to write a program that
* depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect
* bugs.
*
* <p>
* This class is a member of the ="{@docRoot}/../technotes/guides/collections/ index.html" Java Collections
* Framework .
*
Expand Down Expand Up @@ -314,19 +314,10 @@ private static int hugeCapacity(int minCapacity) {

/**
* Returns an array containing all of the elements in this list in proper sequence (from first to last element).
<<<<<<< HEAD
*
* The returned array will be "safe" in that no references to it are maintained by this list. (In other words,
* this method must allocate a new array). The caller is thus free to modify the returned array.
*
* This method acts as bridge between array-based and collection-based APIs.
=======
* </p>
* <p>The returned array will be "safe" in that no references to it are maintained by this list. (In other words,
* this method must allocate a new array). The caller is thus free to modify the returned array.
* </p>
* <p>This method acts as bridge between array-based and collection-based APIs.
>>>>>>> c3ab46726db4f602ab94b02c0236f35f30cebcd7
* <p>This method acts as bridge between array-based and collection-based APIs.</p>
*
* @return an array containing all of the elements in this list in proper sequence
*/
Expand All @@ -343,18 +334,10 @@ private static int hugeCapacity(int minCapacity) {
* runtime type of the returned array is that of the specified array. If the list fits in the specified array, it
* is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the
* size of this list.
<<<<<<< HEAD
*
* If the list fits in the specified array with room to spare (i.e., the array has more elements than the list),
* the element in the array immediately following the end of the collection is set to null . (This is
* useful in determining the length of the list only if the caller knows that the list does not contain any
=======
* </p>
* <p>If the list fits in the specified array with room to spare (i.e., the array has more elements than the list),
* the element in the array immediately following the end of the collection is set to <tt>null</tt>. (This is
* useful in determining the length of the list <i>only</i> if the caller knows that the list does not contain any
>>>>>>> c3ab46726db4f602ab94b02c0236f35f30cebcd7
* null elements.)
* null elements.)</p>
*
* @param <T> the generic type
* @param a the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new
Expand Down Expand Up @@ -759,13 +742,7 @@ private void readObject(java.io.ObjectInputStream s)
* in the list. The specified index indicates the first element that would be returned by an initial call to {@link
* ListIterator#next next}. An initial call to {@link ListIterator#previous previous} would return the element with
* the specified index minus one.
<<<<<<< HEAD
*
* The returned list iterator is ="#fail-fast" fail-fast .
=======
* </p>
* <p>The returned list iterator is <a href="#fail-fast"><i>fail-fast</i></a>.
>>>>>>> c3ab46726db4f602ab94b02c0236f35f30cebcd7
*
* @param index the index
* @return the list iterator
Expand All @@ -779,13 +756,7 @@ private void readObject(java.io.ObjectInputStream s)

/**
* Returns a list iterator over the elements in this list (in proper sequence).
<<<<<<< HEAD
*
* The returned list iterator is ="#fail-fast" fail-fast .
=======
* </p>
* <p>The returned list iterator is <a href="#fail-fast"><i>fail-fast</i></a>.
>>>>>>> c3ab46726db4f602ab94b02c0236f35f30cebcd7
*
* @return the list iterator
* @see #listIterator(int)
Expand All @@ -796,13 +767,7 @@ private void readObject(java.io.ObjectInputStream s)

/**
* Returns an iterator over the elements in this list in proper sequence.
<<<<<<< HEAD
*
* The returned iterator is ="#fail-fast" fail-fast .
=======
* </p>
* <p>The returned iterator is <a href="#fail-fast"><i>fail-fast</i></a>.
>>>>>>> c3ab46726db4f602ab94b02c0236f35f30cebcd7
*
* @return an iterator over the elements in this list in proper sequence
*/
Expand Down Expand Up @@ -960,29 +925,16 @@ private class ListItr extends Itr implements ListIterator<Float> {
* toIndex}, exclusive. (If {@code fromIndex} and {@code toIndex} are equal, the returned list is empty.) The
* returned list is backed by this list, so non-structural changes in the returned list are reflected in this list,
* and vice-versa. The returned list supports all of the optional list operations.
<<<<<<< HEAD
*
* This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays).
=======
* </p>
* <p>This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays).
>>>>>>> c3ab46726db4f602ab94b02c0236f35f30cebcd7
* Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole
* list. For example, the following idiom removes a range of elements from a list:
*
* list.subList(from, to).clear();
*
* Similar idioms may be constructed for {@link #indexOf(Object)} and {@link #lastIndexOf(Object)}, and all of the
* algorithms in the {@link Collections} class can be applied to a subList.
<<<<<<< HEAD
*
* The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is
* structurally modified in any way other than via the returned list. (Structural modifications are those
=======
* </p>
* <p>The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is
* <i>structurally modified</i> in any way other than via the returned list. (Structural modifications are those
>>>>>>> c3ab46726db4f602ab94b02c0236f35f30cebcd7
* that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may
* yield incorrect results.)
*
Expand Down
Loading
Loading