Merge pull request #107 from Daniel-Dos/fix-javadoc

small fix in generated javadoc.

Author: keilw

pom.xml

@@ -555,7 +555,7 @@
 				<plugin>
 					<groupId>org.apache.maven.plugins</groupId>
 					<artifactId>maven-javadoc-plugin</artifactId>
-					<version>3.0.0</version>
+					<version>3.0.1</version>
 					<configuration>
 						<excludes>java.money</excludes>
 						<excludePackageNames>java.money</excludePackageNames>
@@ -879,7 +879,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-javadoc-plugin</artifactId>
-				<version>2.9.1</version>
+				<version>3.0.1</version>
 				<inherited>true</inherited>
 				<reportSets>
 					<reportSet>

src/main/java/javax/money/AbstractContextBuilder.java

@@ -176,7 +176,7 @@ public B set(String key, Object value) {
      * <i>type</i>.
      *
      * @param value the attribute value, not null.
-     * @param key   the attribute's key, not {@code null}
+     * @param key the attribute's key, not {@code null}
      * @return this Builder, for chaining
      */
     public <T> B set(Class<T> key, T value) {

src/main/java/javax/money/CurrencyUnit.java

@@ -25,7 +25,7 @@
  * <p>
  * Currencies can be distinguished by separate {@link #getCurrencyCode()} codes,
  * similar to {@link java.util.Currency}.
- * <h4>Implementation specification</h4>
+ * <h3>Implementation specification</h3>
  * Implementation of this class
  * <ul>
  * <li>are required to implement {@code equals/hashCode} considering the

src/main/java/javax/money/MonetaryAmount.java

@@ -67,7 +67,7 @@
  * </code></pre>
  * </blockquote></li>
  * </ul>
- * <h4>Implementation specification</h4>
+ * <h3>Implementation specification</h3>
  * Implementations of this interface must be
  * <ul>
  * <li>thread-safe</li>
@@ -154,7 +154,7 @@ default <R> R query(MonetaryQuery<R> query){
      * <p>
      * Hereby also the method signature on the implementation type must return the concrete type, to
      * enable a fluent API, e.g.
-     * <p>
+     *
      * <blockquote>
      * <pre><code>
      * public final class MyMoney implements MonetaryAmount{
@@ -315,8 +315,8 @@ default boolean isZero(){
     MonetaryAmount subtract(MonetaryAmount amount);
 
     /**
-     * Returns a {@code MonetaryAmount} whose value is <tt>(this &times;
-     * multiplicand)</tt>, and whose scale is <code>this.scale() +
+     * Returns a {@code MonetaryAmount} whose value is <code>(this &times;
+     * multiplicand)</code>, and whose scale is <code>this.scale() +
      * multiplicand.scale()</code>.
      *
      * @param multiplicand value to be multiplied by this {@code MonetaryAmount}.
@@ -327,8 +327,8 @@ default boolean isZero(){
     MonetaryAmount multiply(long multiplicand);
 
     /**
-     * Returns a {@code MonetaryAmount} whose value is <tt>(this &times;
-     * multiplicand)</tt>, and whose scale is <code>this.scale() +
+     * Returns a {@code MonetaryAmount} whose value is <code>(this &times;
+     * multiplicand)</code>, and whose scale is <code>this.scale() +
      * multiplicand.scale()</code>.
      * By default the input value's scale will be rounded to
      * accommodate the format capabilities, and no {@link java.lang.ArithmeticException}
@@ -345,8 +345,8 @@ default boolean isZero(){
 
 
     /**
-     * Returns a {@code MonetaryAmount} whose value is <tt>(this &times;
-     * multiplicand)</tt>, and whose scale is <code>this.scale() +
+     * Returns a {@code MonetaryAmount} whose value is <code>(this &times;
+     * multiplicand)</code>, and whose scale is <code>this.scale() +
      * multiplicand.scale()</code>.
      *
      * @param multiplicand value to be multiplied by this {@code MonetaryAmount}. If the multiplicand's scale exceeds
@@ -402,7 +402,7 @@ default boolean isZero(){
 
     /**
      * Returns a {@code MonetaryAmount} whose value is <code>this % divisor</code>.
-     * <p>
+     *
      * <p>
      * The remainder is given by
      * <code>this.subtract(this.divideToIntegralValue(divisor).multiply(divisor)</code> . Note that this
@@ -418,7 +418,7 @@ default boolean isZero(){
 
     /**
      * Returns a {@code MonetaryAmount} whose value is <code>this % divisor</code>.
-     * <p>
+     *
      * <p>
      * The remainder is given by
      * <code>this.subtract(this.divideToIntegralValue(divisor).multiply(divisor)</code> . Note that this
@@ -434,7 +434,7 @@ default boolean isZero(){
 
     /**
      * Returns a {@code MonetaryAmount} whose value is <code>this % divisor</code>.
-     * <p>
+     *
      * <p>
      * The remainder is given by
      * <code>this.subtract(this.divideToIntegralValue(divisor).multiply(divisor)</code> . Note that this
@@ -452,7 +452,7 @@ default boolean isZero(){
      * Returns a two-element {@code MonetaryAmount} array containing the result of
      * {@code divideToIntegralValue} followed by the result of {@code remainder} on the two
      * operands.
-     * <p>
+     *
      * <p>
      * Note that if both the integer quotient and remainder are needed, this method is faster than
      * using the {@code divideToIntegralValue} and {@code remainder} methods separately because the
@@ -475,7 +475,7 @@ default boolean isZero(){
      * Returns a two-element {@code MonetaryAmount} array containing the result of
      * {@code divideToIntegralValue} followed by the result of {@code remainder} on the two
      * operands.
-     * <p>
+     *
      * <p>
      * Note that if both the integer quotient and remainder are needed, this method is faster than
      * using the {@code divideToIntegralValue} and {@code remainder} methods separately because the
@@ -498,7 +498,7 @@ default boolean isZero(){
      * Returns a two-element {@code MonetaryAmount} array containing the result of
      * {@code divideToIntegralValue} followed by the result of {@code remainder} on the two
      * operands.
-     * <p>
+     *
      * <p>
      * Note that if both the integer quotient and remainder are needed, this method is faster than
      * using the {@code divideToIntegralValue} and {@code remainder} methods separately because the

src/main/java/javax/money/MonetaryAmountFactory.java

@@ -51,7 +51,7 @@
  * <li>{@code a.b.MyMoney.ctx.maxScale} to define the maximal supported scale.</li>
  * <li>{@code a.b.MyMoney.ctx.fixedScale} to define the scale to be fixed (constant).</li>
  * </ul>
- * <p>
+ * 
  * <h2>Implementation specification</h2> Instances of this interface are <b>not</b> required to be
  * thread-safe!
  *

src/main/java/javax/money/MonetaryContextBuilder.java

@@ -76,6 +76,7 @@ public MonetaryContextBuilder setFixedScale(boolean fixedScale) {
     /**
      * Set the MonetaryAmount implementation class.
      *
+     * @param amountType the target amount type, not null.
      * @return the implementation class of the containing amount instance, never null.
      * @see javax.money.MonetaryAmount#getContext()
      */

src/main/java/javax/money/MonetaryException.java

@@ -46,7 +46,7 @@ public MonetaryException(String message) {
 	 *            {@link Throwable#getMessage()} method).
 	 * @param cause
 	 *            the cause (which is saved for later retrieval by the
-	 *            {@link Throwable#getCause()} method). (A <tt>null</tt> value
+	 *            {@link Throwable#getCause()} method). (A <code>null</code> value
 	 *            is permitted, and indicates that the cause is nonexistent or
 	 *            unknown.)
 	 */

src/main/java/javax/money/MonetaryOperator.java

@@ -24,10 +24,13 @@
  * <p>
  * Examples might be an operator that rounds the amount to the nearest 1000, or
  * one that performs currency conversion.
+ * </p>
+ *
  * <p>
  * There are two equivalent ways of using a {@code MonetaryOperator}. The first
  * is to invoke the method on this interface. The second is to use
  * {@link MonetaryAmount#with(MonetaryOperator)}:
+ * </p>
  *
  * <pre><code>
  * // these two lines are equivalent, but the second approach is recommended
@@ -38,21 +41,28 @@
  * It is recommended to use the second approach, {@code with(MonetaryOperator)},
  * as it is a lot clearer to read in code.
  *
- * <h4>Implementation specification</h4>
+ * <h3>Implementation specification</h3>
+ * <p>
  * The implementation must take the input object and apply it. The
  * implementation defines the logic of the operator and is responsible for
  * documenting that logic. It may use any method on {@code MonetaryAmount} to
  * determine the result.
+ * </p>
+ * 
  * <p>
  * The input object must not be altered. Instead, an altered copy of the
  * original must be returned. This provides equivalent, safe behavior for
  * immutable and mutable monetary amounts.
+ * </p>
+ * 
  * <p>
  * This method may be called from multiple threads in parallel. It must be
  * thread-safe when invoked.
+ * </p>
  *
  * <p>
  * This interface extends {@code java.util.function.UnaryOperator} introduced by Java 8.
+ * </p>
  *
  * @author Werner Keil
  * @author Anatole Tresch

src/main/java/javax/money/MonetaryQuery.java

@@ -37,7 +37,7 @@
  * 
  * It is recommended to use the second approach, {@code query(MonetaryQuery)},
  * as it is a lot clearer to read in code.
- * <h4>Implementation specification</h4>
+ * <h3>Implementation specification</h3>
  * This interface places no restrictions on the mutability of implementations,
  * however immutability is strongly recommended.
  * 
@@ -72,7 +72,7 @@ public interface MonetaryQuery<R>{
 	 * It is recommended to use the second approach,
 	 * {@code query(MonetaryQuery)}, as it is a lot clearer to read in code.
 	 * 
-	 * <h4>Implementation specification</h4>
+	 * <h3>Implementation specification</h3>
 	 * The implementation must take the input object and query it. The
 	 * implementation defines the logic of the query and is responsible for
 	 * documenting that logic. It may use any method on {@code MonetaryAmount}

src/main/java/javax/money/MonetaryRounding.java

@@ -19,7 +19,7 @@
 /**
  * Interface representing a monetary rounding. Rounding must not necessarily represent roundings in a pure arithmetical sense. Basically a rounding
  * can scale an amount arbitrarily.
- * <h4>Implementation specification</h4>
+ * <h3>Implementation specification</h3>
  * Implementations of this interface must be
  * <ul>
  *     <li>final</li>