Add a task to compile javadoc across all packages (#597)

Also fixes various issues that prevent javadoc compliation.

util/src/main/java/google/registry/util/AppEngineServiceUtils.java

@@ -47,8 +47,9 @@ public interface AppEngineServiceUtils {
    * GCP. The work-around is to change all of the "." subdomain markers to "-dot-". E.g.:
    *
    * <ul>
-   *   <li>tools.projectid.appspot.com --> tools-dot-projectid.appspot.com
-   *   <li>version.backend.projectid.appspot.com --> version-dot-backend-dot-projectid.appspot.com
+   *   <li>tools.projectid.appspot.com --&gt; tools-dot-projectid.appspot.com
+   *   <li>version.backend.projectid.appspot.com --&gt;
+   *       version-dot-backend-dot-projectid.appspot.com
    * </ul>
    *
    * @see <a

util/src/main/java/google/registry/util/CircularList.java

@@ -15,11 +15,11 @@
 package google.registry.util;
 
 /**
- * Class that stores value {@param <T>}, and points in circle to other {@link CircularList} objects.
+ * Class that stores value {@code <T>}, and points in circle to other {@link CircularList} objects.
  *
- * <p>In its construction, we create a sequence of {@link CircularList} objects, each storing an *
- * instance of T. They each point to each other in a circular manner, such that we can perform *
- * circular iteration on the elements. Once finished building, we return this first {@link *
+ * <p>In its construction, we create a sequence of {@link CircularList} objects, each storing an
+ * instance of T. They each point to each other in a circular manner, such that we can perform
+ * circular iteration on the elements. Once finished building, we return this first {@link
  * CircularList} object in the sequence.
  *
  * @param <T> - Element type stored in the {@link CircularList}

util/src/main/java/google/registry/util/ImprovedInputStream.java

@@ -136,8 +136,6 @@ public class ImprovedInputStream extends FilterInputStream {
    * Overridable method that's called by {@link #close()}.
    *
    * <p>This method does nothing by default.
-   *
-   * @throws IOException
    */
   protected void onClose() throws IOException {
     // Does nothing by default.

util/src/main/java/google/registry/util/ImprovedOutputStream.java

@@ -115,8 +115,6 @@ public class ImprovedOutputStream extends FilterOutputStream {
    * Overridable method that's called by {@link #close()}.
    *
    * <p>This method does nothing by default.
-   *
-   * @throws IOException
    */
   protected void onClose() throws IOException {
     // Does nothing by default.

util/src/main/java/google/registry/util/NetworkUtils.java

@@ -86,7 +86,7 @@ public final class NetworkUtils {
    * href="http://bugs.java.com/bugdatabase/view_bug.do?bug_id=4665037">issue</a> in {@link
    * InetAddress#getLocalHost}.
    *
-   * <p><b>Note:</b> This code was pilfered from {@link "com.google.net.base.LocalHost"} which was
+   * <p><b>Note:</b> This code was pilfered from {@code com.google.net.base.LocalHost} which was
    * never made open source.
    *
    * @throws UnknownHostException if the local host could not be resolved into an address

util/src/main/java/google/registry/util/NonFinalForTesting.java

@@ -32,8 +32,6 @@ import java.lang.annotation.Target;
  *
  * <p>When this annotation is used on methods, it means that you should not override the method
  * and it's only non-{@code final} so it can be mocked.
- *
- * @see google.registry.testing.InjectRule
  */
 @Documented
 @Retention(SOURCE)

util/src/main/java/google/registry/util/PosixTarHeader.java

@@ -416,8 +416,6 @@ public final class PosixTarHeader {
      * <p>The modified time is always stored as a UNIX timestamp which is seconds since the UNIX
      * epoch in UTC time. Because {@link DateTime} has millisecond precision, it gets rounded down
      * (floor) to the second.
-     *
-     * @throws NullPointerException
      */
     public Builder setMtime(DateTime mtime) {
       checkNotNull(mtime, "mtime");

util/src/main/java/google/registry/util/Retrier.java

@@ -68,7 +68,7 @@ public class Retrier implements Serializable {
    * original exception is propagated through to the caller. Checked exceptions are wrapped in a
    * RuntimeException, while unchecked exceptions are propagated as-is.
    *
-   * @return <V> the value returned by the {@link Callable}.
+   * @return the value returned by the {@link Callable}.
    */
   public <V> V callWithRetry(Callable<V> callable, Predicate<Throwable> isRetryable) {
     return callWithRetry(callable, LOGGING_FAILURE_REPORTER, isRetryable);
@@ -85,7 +85,7 @@ public class Retrier implements Serializable {
    *
    * <p>Uses a default FailureReporter that logs before each retry.
    *
-   * @return <V> the value returned by the {@link Callable}.
+   * @return the value returned by the {@link Callable}.
    */
   @SafeVarargs
   public final <V> V callWithRetry(
@@ -117,7 +117,7 @@ public class Retrier implements Serializable {
    * exception is propagated through to the caller. Checked exceptions are wrapped in a
    * RuntimeException, while unchecked exceptions are propagated as-is.
    *
-   * @return <V> the value returned by the {@link Callable}.
+   * @return the value returned by the {@link Callable}.
    */
   @SafeVarargs
   public final <V> V callWithRetry(

util/src/main/java/google/registry/util/TypeUtils.java

@@ -30,7 +30,7 @@ import java.util.function.Predicate;
 /** Utilities methods related to reflection. */
 public class TypeUtils {
 
-  /** A {@TypeToken} that removes an ugly cast in the common cases of getting a known type. */
+  /** A {@code TypeToken} that removes an ugly cast in the common cases of getting a known type. */
   public static class TypeInstantiator<T> extends TypeToken<T> {
     protected TypeInstantiator(Class<?> declaringClass) {
       super(declaringClass);
@@ -94,9 +94,7 @@ public class TypeUtils {
     return castedClass;
   }
 
-  /**
-   * Aggregates enum "values" in a typesafe enum pattern into a string->field map.
-   */
+  /** Aggregates enum "values" in a typesafe enum pattern into a string-&gt;field map. */
   @SuppressWarnings("unchecked")
   public static <T> ImmutableMap<String, T> getTypesafeEnumMapping(Class<T> clazz) {
     ImmutableMap.Builder<String, T> builder = new ImmutableMap.Builder<>();