From 34d47b4193f7e9b0b81a3203aac3bf237b722509 Mon Sep 17 00:00:00 2001
From: Marco Schulte <marco.schulte@eckert-partner.it>
Date: Fri, 23 Sep 2016 09:43:19 +0200
Subject: [PATCH] Fixed Javadoc compilation

---
 .../oath/otp/keyprovisioning/OTPAuthURI.java   |  8 ++++----
 .../otp/keyprovisioning/OTPAuthURIBuilder.java |  9 ++++-----
 .../keyprovisioning/qrcode/QRCodeWriter.java   |  2 +-
 .../com/lochbridge/oath/otp/HOTPBuilder.java   |  2 +-
 .../com/lochbridge/oath/otp/HOTPValidator.java |  2 +-
 .../com/lochbridge/oath/otp/TOTPBuilder.java   | 18 +++++++++---------
 .../com/lochbridge/oath/otp/TOTPValidator.java |  2 +-
 7 files changed, 21 insertions(+), 22 deletions(-)

diff --git a/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/OTPAuthURI.java b/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/OTPAuthURI.java
index 8256d99..f6d6f53 100644
--- a/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/OTPAuthURI.java
+++ b/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/OTPAuthURI.java
@@ -11,7 +11,7 @@
 /**
  * An immutable class representing an OTP Auth URI (as per the 
  * <a href="https://code.google.com/p/google-authenticator/wiki/KeyUriFormat">Google Authenticator URI format</a>):
- * <pre>otpauth://{type}/{label}?secret={secret}&issuer={issuer}&digits={digits}&counter={counter}&period={period}</pre>
+ * <pre>otpauth://{type}/{label}?secret={secret}&amp;issuer={issuer}&amp;digits={digits}&amp;counter={counter}&amp;period={period}</pre>
  * <ul>
  * <li>{@code type}: The OTP type, either "hotp" or "totp".</li>
  * <li>{@code label}: The label used to identify which account the underlying key is associated with. 
@@ -32,7 +32,7 @@
  * String issuer = "Acme Corporation";
  * String label = issuer + ":Alice Smith";
  * OTPAuthURI uri = OTPAuthURIBuilder.fromKey(new OTPKey(secret, OTPType.TOTP)).label(label).issuer(issuer).digits(6).timeStep(30000L).build();
- * // Prints "otpauth://totp/Acme%20Corporation:Alice%20Smith?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=Acme%20Corporation&digits=6&period=30"
+ * // Prints "otpauth://totp/Acme%20Corporation:Alice%20Smith?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&amp;issuer=Acme%20Corporation&amp;digits=6&amp;period=30"
  * System.out.println(uri.toUriString());
  * </pre>
  */
@@ -241,7 +241,7 @@ public String toPlainTextUriString() {
      * the individual components were themselves decoded/plain-text when this instance was built (this is a prerequisite). 
      * <p>
      * The URI conforms to the following format:
-     * <pre>otpauth://{type}/{label}?secret={secret}&issuer={issuer}&digits={digits}&counter={counter}&period={period}</pre>
+     * <pre>otpauth://{type}/{label}?secret={secret}&amp;issuer={issuer}&amp;digits={digits}&amp;counter={counter}&amp;period={period}</pre>
      * <ul>
      * <li>{@code type}: The OTP type, either "hotp" or "totp".</li>
      * <li>{@code label}: The label used to identify which account the underlying key is associated with. 
@@ -311,7 +311,7 @@ private static final String safeEncodeLabel(String label) {
      * <li>The unreserved characters ".", "-", "~", and "_" remain the same.
      * <li>The additional "pchar" characters "@" and ":" remain the same.
      * <li>The sub-delimiters "!", "$", "'", "(", ")", "*", ",", and ";" remain the same.
-     * ('+', '&' and '=' are excluded)
+     * ('+', '&amp;' and '=' are excluded)
      * <li>The additional "query" characters "/", and "?" remain the same.
      * <li>The space character " " is converted into %20.
      * <li>All other characters are converted into one or more bytes using UTF-8
diff --git a/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/OTPAuthURIBuilder.java b/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/OTPAuthURIBuilder.java
index 03d5a5b..82005ac 100644
--- a/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/OTPAuthURIBuilder.java
+++ b/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/OTPAuthURIBuilder.java
@@ -29,7 +29,7 @@
  * String issuer = "Acme Corporation";
  * String label = issuer + ":Alice Smith";
  * OTPAuthURI uri = OTPAuthURIBuilder.fromKey(new OTPKey(secret, OTPType.TOTP)).label(label).issuer(issuer).digits(6).timeStep(30000L).build();
- * // Prints "otpauth://totp/Acme%20Corporation:Alice%20Smith?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=Acme%20Corporation&digits=6&period=30"
+ * // Prints "otpauth://totp/Acme%20Corporation:Alice%20Smith?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&amp;issuer=Acme%20Corporation&amp;digits=6&amp;period=30"
  * System.out.println(uri.toUriString());
  * 
  * OTPAuthURI uriExample2 = OTPAuthURIBuilder.fromUriString(uri.toUriString()).build();
@@ -130,8 +130,7 @@ public static OTPAuthURIBuilder fromKey(OTPKey key) {
      *             (see {@link OTPAuthURIBuilder#counter(long)}).
      * @throws IllegalArgumentException 
      *             if {@code uri} is TOTP-based and the period parameter (and/or value) 
-     *             is missing, or invalid numerical format, or out of the acceptable range 
-     *             (see {@link OTPAuthURIBuilder#period(long)}).
+     *             is missing, or invalid numerical format, or out of the acceptable range
      */
     public static OTPAuthURIBuilder fromUriString(String uri) {
         Preconditions.checkNotNull(uri);
@@ -377,7 +376,7 @@ public OTPAuthURIBuilder digits(int digits) {
      *         specified counter.
      *         
      * @throws IllegalArgumentException
-     *             if {@code counter} is < 0.
+     *             if {@code counter} is {@literal <} 0.
      */
     public OTPAuthURIBuilder counter(long counter) {
         Preconditions.checkArgument(counter >= 0);
@@ -399,7 +398,7 @@ public OTPAuthURIBuilder counter(long counter) {
      *         specified timeStep.
      * 
      * @throws IllegalArgumentException
-     *             if {@code timeStep} is <= 0.
+     *             if {@code timeStep} is {@literal <=} 0.
      */
     public OTPAuthURIBuilder timeStep(long timeStep) {
         Preconditions.checkArgument(timeStep > 0);
diff --git a/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/qrcode/QRCodeWriter.java b/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/qrcode/QRCodeWriter.java
index 18993a4..1e1abca 100644
--- a/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/qrcode/QRCodeWriter.java
+++ b/oath-otp-keyprovisioning/src/main/java/com/lochbridge/oath/otp/keyprovisioning/qrcode/QRCodeWriter.java
@@ -97,7 +97,7 @@ public QRCodeWriter height(int height) {
     /**
      * Returns this {@code QRCodeWriter} instance initialized with the
      * specified {@link ErrorCorrectionLevel}. The default is
-     * {@link ErrorCorrectionLevel.L}.
+     * {@link ErrorCorrectionLevel#L}.
      * 
      * @param errorCorrectionLevel
      *            the error correction level.
diff --git a/oath-otp/src/main/java/com/lochbridge/oath/otp/HOTPBuilder.java b/oath-otp/src/main/java/com/lochbridge/oath/otp/HOTPBuilder.java
index 7e9baf0..f784068 100644
--- a/oath-otp/src/main/java/com/lochbridge/oath/otp/HOTPBuilder.java
+++ b/oath-otp/src/main/java/com/lochbridge/oath/otp/HOTPBuilder.java
@@ -94,7 +94,7 @@ public final class HOTPBuilder {
      *         {@code movingFactor}.
      * 
      * @throws IllegalArgumentException
-     *             if {@code movingFactor} is < 0.
+     *             if {@code movingFactor} is {@literal <} 0.
      */
     public HOTPBuilder movingFactor(long movingFactor) {
         Preconditions.checkArgument(movingFactor >= 0);
diff --git a/oath-otp/src/main/java/com/lochbridge/oath/otp/HOTPValidator.java b/oath-otp/src/main/java/com/lochbridge/oath/otp/HOTPValidator.java
index 695de93..9410c0e 100644
--- a/oath-otp/src/main/java/com/lochbridge/oath/otp/HOTPValidator.java
+++ b/oath-otp/src/main/java/com/lochbridge/oath/otp/HOTPValidator.java
@@ -97,7 +97,7 @@ public static HOTPValidator defaultLookAheadWindow() {
      * @return a new {@link HOTPValidator} instance.
      * 
      * @throws IllegalArgumentException
-     *             if {@code lookAheadWindow} is < 1.
+     *             if {@code lookAheadWindow} is {@literal <} 1.
      */
     public static HOTPValidator lookAheadWindow(int lookAheadWindow) {
         return new HOTPValidator(lookAheadWindow);
diff --git a/oath-otp/src/main/java/com/lochbridge/oath/otp/TOTPBuilder.java b/oath-otp/src/main/java/com/lochbridge/oath/otp/TOTPBuilder.java
index bd4db45..d94eb7c 100644
--- a/oath-otp/src/main/java/com/lochbridge/oath/otp/TOTPBuilder.java
+++ b/oath-otp/src/main/java/com/lochbridge/oath/otp/TOTPBuilder.java
@@ -112,7 +112,7 @@ public final class TOTPBuilder {
      *         {@code timeStep} size.
      * 
      * @throws IllegalArgumentException
-     *             if {@code timeStep} is <= 0.
+     *             if {@code timeStep} is {@literal <=} 0.
      */
     public TOTPBuilder timeStep(long timeStep) {
         Preconditions.checkArgument(timeStep > 0);
@@ -163,10 +163,10 @@ public TOTPBuilder hmacSha(HmacShaAlgorithm algorithm) {
 
     /**
      * Returns this {@code TOTPBuilder} instance initialized with the
-     * {@link HmacShaAlgorithm.HMAC_SHA_1}.
+     * {@link HmacShaAlgorithm#HMAC_SHA_1}.
      * 
      * @return this {@code TOTPBuilder} instance initialized with the
-     *         {@link HmacShaAlgorithm.HMAC_SHA_1}.
+     *         {@link HmacShaAlgorithm#HMAC_SHA_1}.
      */
     public TOTPBuilder hmacSha1() {
         return hmacSha(HmacShaAlgorithm.HMAC_SHA_1);
@@ -174,10 +174,10 @@ public TOTPBuilder hmacSha1() {
 
     /**
      * Returns this {@code TOTPBuilder} instance initialized with the
-     * {@link HmacShaAlgorithm.HMAC_SHA_256}.
+     * {@link HmacShaAlgorithm#HMAC_SHA_256}.
      * 
      * @return this {@code TOTPBuilder} instance initialized with the
-     *         {@link HmacShaAlgorithm.HMAC_SHA_256}.
+     *         {@link HmacShaAlgorithm#HMAC_SHA_256}.
      */
     public TOTPBuilder hmacSha256() {
         return hmacSha(HmacShaAlgorithm.HMAC_SHA_256);
@@ -185,10 +185,10 @@ public TOTPBuilder hmacSha256() {
 
     /**
      * Returns this {@code TOTPBuilder} instance initialized with the
-     * {@link HmacShaAlgorithm.HMAC_SHA_512}.
+     * {@link HmacShaAlgorithm#HMAC_SHA_512}.
      * 
      * @return this {@code TOTPBuilder} instance initialized with the
-     *         {@link HmacShaAlgorithm.HMAC_SHA_512}.
+     *         {@link HmacShaAlgorithm#HMAC_SHA_512}.
      */
     public TOTPBuilder hmacSha512() {
         return hmacSha(HmacShaAlgorithm.HMAC_SHA_512);
@@ -213,12 +213,12 @@ public TOTP build() {
      * configuration/generation calls.
      * 
      * @param time
-     *            the time (in milliseconds) (must be >= 0)
+     *            the time (in milliseconds) (must be {@literal >= 0})
      * 
      * @return a Time-based One-time Password {@link TOTP} instance.
      * 
      * @throws IllegalArgumentException
-     *             if {@code time} < 0.
+     *             if {@code time} {@literal <} 0.
      */
     public TOTP build(long time) {
         Preconditions.checkArgument(time >= 0);
diff --git a/oath-otp/src/main/java/com/lochbridge/oath/otp/TOTPValidator.java b/oath-otp/src/main/java/com/lochbridge/oath/otp/TOTPValidator.java
index 9a04028..d30efdd 100644
--- a/oath-otp/src/main/java/com/lochbridge/oath/otp/TOTPValidator.java
+++ b/oath-otp/src/main/java/com/lochbridge/oath/otp/TOTPValidator.java
@@ -87,7 +87,7 @@ public static TOTPValidator defaultWindow() {
      * @return a new {@link TOTPValidator} instance.
      * 
      * @throws IllegalArgumentException
-     *             if {@code window} is < 0.
+     *             if {@code window} is {@literal <} 0.
      */
     public static TOTPValidator window(int window) {
         return new TOTPValidator(window);