mathd: javadoc

src/main/java/com/simsilica/mathd/Matrix3d.java

@@ -38,8 +38,14 @@
 
 
 /**
- * A matrix composed of 9 double-precision elements, used to represent
- * rotations in 3-dimensional space.
+ * A square matrix composed of 9 double-precision elements, used to represent
+ * linear transformations of 3-dimensional vectors.
+ * <p>
+ * Methods with names ending in "Local" modify the current instance. They are
+ * used to avoid creating temporary objects.
+ * <p>
+ * By convention, indices start from zero. The conventional order of indices is
+ * (row, column).
  *
  *  @author    Paul Speed
  */

src/main/java/com/simsilica/mathd/Quatd.java

@@ -44,8 +44,12 @@
  * space, without risk of gimbal lock. Each instance has 4 double-precision
  * components: 3 imaginary components (X, Y, and Z) and a real component (W).
  * <p>
+ * Methods with names ending in "Local" modify the current instance. They are
+ * used to avoid creating temporary objects.
+ * <p>
  * Mathematically, quaternions are an extension of complex numbers. In
- * mathematics texts, W often appears first, but here order is (X, Y, Z, W).
+ * mathematics texts, W often appears first, but here the conventional order
+ * is (X, Y, Z, W).
  *
  *  @version   $Revision: 3951 $
  *  @author    Paul Speed

src/main/java/com/simsilica/mathd/Vec3d.java

@@ -46,7 +46,7 @@
  * Methods with names ending in "Local" modify the current instance. They are
  * used to avoid creating temporary vectors.
  * <p>
- * The conventional ordering of components is (X, Y, Z).
+ * The conventional order of components is (X, Y, Z).
  *
  *  @version   $Revision: 3951 $
  *  @author    Paul Speed