UNITSOFMEASUREMENT-11: API JavaDoc

Task-Url: https://java.net/jira/browse/UNITSOFMEASUREMENT-11

Author: keilw

src/main/java/javax/measure/Unit.java

@@ -67,7 +67,7 @@
  * @author <a href="mailto:steve@unidata.ucar.edu">Steve Emmerson</a>
  * @author <a href="mailto:desruisseaux@users.sourceforge.net">Martin Desruisseaux</a>
  * @author <a href="mailto:units@catmedia.us">Werner Keil</a>
- * @version 0.20, December 30, 2015
+ * @version 0.21, April 3, 2016
  *
  * @see <a href="http://en.wikipedia.org/wiki/Units_of_measurement">Wikipedia: Units of measurement</a>
  */
@@ -83,7 +83,7 @@ public interface Unit<Q extends Quantity<Q>> {
    * @return this unit symbol, or {@code null} if this unit has not specific symbol associated with (e.g. product of units).
    *
    * @see #toString()
-   * @see UnitFormat
+   * @see javax.measure.format.UnitFormat
    */
   String getSymbol();
 
@@ -93,7 +93,7 @@ public interface Unit<Q extends Quantity<Q>> {
    * @return this unit name, or {@code null} if this unit has not specific name associated with (e.g. product of units).
    *
    * @see #toString()
-   * @see UnitFormat
+   * @see javax.measure.format.UnitFormat
    */
   String getName();
 

src/main/java/javax/measure/package-info.java

@@ -31,12 +31,12 @@
  * Specifies Java packages for the programmatic, type safe handling
  * of quantities and their expression as values of units.
  *
- * <p>The core interfaces of this package are {@link javax.measure.Measurement}, {@link javax.measure.Quantity} and {@link javax.measure.Unit}.</p>
+ * <p>The core interfaces of this package are {@link javax.measure.Dimension}, {@link javax.measure.Quantity} and {@link javax.measure.Unit}.</p>
  *
  * @author <a href="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a>
  * @author <a href="mailto:units@catmedia.us">Werner Keil</a>
  * @author <a href="mailto:llima@v2com.mobi">Leonardo de Moura Rocha Lima</a>
- * @version 1.2 ($Revision: 395 $), $Date: 2014-01-27 23:16:02 +0100 (Mo, 27 Jän 2014) $
+ * @version 1.3 ($Revision: 395 $), $Date: 2016-04-03 $
  *
  */
 package javax.measure;

src/main/java/javax/measure/quantity/Acceleration.java

@@ -35,12 +35,14 @@
  * Rate of change of velocity with respect to time. The metric system unit for this quantity is "m/s²" (metre per square second).
  *
  * @author <a href="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a>
- * @version 1.0
+ * @author <a href="mailto:units@catmedia.us">Werner Keil</a>
+ * @version 1.1
+ * 
+ * @see <a href="https://en.wikipedia.org/wiki/Acceleration">Wikipedia: Acceleration</a>
  *
  * @see Length
  * @see Speed
  * @see Time
- * @see AngularAcceleration
  */
 public interface Acceleration extends Quantity<Acceleration> {
 }

src/main/java/javax/measure/quantity/AmountOfSubstance.java

@@ -36,9 +36,9 @@
  *
  * @author <a href="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a>
  * @author <a href="mailto:units@catmedia.us">Werner Keil</a>
- * @version 1.2
+ * @version 1.3
  * 
- * @see <a href=" http://en.wikipedia.org/wiki/Amount_of_substance">Wikipedia: Amount of Substance</a>
+ * @see <a href="http://en.wikipedia.org/wiki/Amount_of_substance">Wikipedia: Amount of Substance</a>
  * 
  * @apiNote SI Base Unit
  */

src/test/java/javax/measure/test/TestUnit.java

@@ -73,6 +73,7 @@ public Unit<Q> shift(double offset) {
     return this;
   }
 
+  @SuppressWarnings({ "unchecked", "rawtypes" })
   public Unit<Q> alternate(String symbol) {
     return new BaseUnit(symbol);
   }
@@ -136,7 +137,6 @@ public String getName() {
   }
 
   public Map<Unit<?>, Integer> getProductUnits() {
-    // TODO Auto-generated method stub
     return null;
   }
 
@@ -145,49 +145,42 @@ public String getSymbol() {
   }
 
   public Unit<?> inverse() {
-    // TODO Auto-generated method stub
     return null;
   }
 
   public boolean isCompatible(Unit<?> that) {
-    // TODO Auto-generated method stub
     return false;
   }
 
   public Unit<Q> multiply(double factor) {
-    // TODO Auto-generated method stub
     return null;
   }
 
   public Unit<?> multiply(Unit<?> that) {
-    // TODO Auto-generated method stub
     return null;
   }
 
   public Unit<?> pow(int n) {
-    // TODO Auto-generated method stub
     return null;
   }
 
   public Unit<?> root(int n) {
-    // TODO Auto-generated method stub
     return null;
   }
 
   public abstract Unit<Q> getSystemUnit();
 
   /**
-   * Returns the converter from this unit to its unscaled {@link #toSysemUnit System Unit} unit.
+   * Returns the converter from this unit to its unscaled {@link #getSystemUnit System Unit} unit.
    *
    * @return <code>getConverterTo(this.toSystemUnit())</code>
-   * @see #toSI
+   * @see #getSystemUnit
    */
   public UnitConverter getSystemConverter() throws UnsupportedOperationException {
     return TestConverter.IDENTITY;
   }
 
   public Unit<Q> transform(UnitConverter operation) {
-    // TODO Auto-generated method stub
     return null;
   }
 

src/test/java/javax/measure/test/format/TestFormat.java

@@ -56,7 +56,7 @@
  *
  * @author <a href="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a>
  * @author <a href="mailto:units@catmedia.us">Werner Keil</a>
- * @version 0.3
+ * @version 0.8
  *
  */
 abstract class TestFormat implements UnitFormat {
@@ -117,11 +117,11 @@ public final Unit<?> parse(CharSequence csq) throws ParserException {
   }
 
   /**
-   * Formats an object to produce a string. This is equivalent to <blockquote> {@link #format(Unit, StringBuilder) format}<code>(unit,
+   * Formats an object to produce a string. This is equivalent to <blockquote> {@link #format(Unit, Appendable) format}<code>(unit,
    *         new StringBuilder()).toString();</code> </blockquote>
    *
-   * @param obj
-   *          The object to format
+   * @param unit
+   *          The unit to format
    * @return Formatted string.
    * @exception IllegalArgumentException
    *              if the Format cannot format the given object

src/test/java/javax/measure/test/quantity/TestQuantity.java

@@ -107,8 +107,8 @@ public String toString() {
   }
 
   /**
-   * Compares this quantity to the specified Measurement quantity. The default implementation compares the {@link AbstractQuantity#doubleValue(Unit)}
-   * of both this quantity and the specified Quantity stated in the same unit (this quantity's {@link #getUnit() unit}).
+   * Compares this quantity to the specified Measurement quantity. The default implementation compares the {@link Quantity#getValue()} of both this
+   * quantity and the specified Quantity stated in the same unit (this quantity's {@link #getUnit() unit}).
    *
    * @return a negative integer, zero, or a positive integer as this quantity is less than, equal to, or greater than the specified Quantity quantity.
    * @return <code>Double.compare(this.doubleValue(getUnit()),