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

Also fixes various issues that prevent javadoc compliation.

build.gradle

@@ -197,6 +197,10 @@ task runPresubmits(type: Exec) {
   args('config/presubmits.py')
 }
 
+def javadocSource = []
+def javadocClasspath = []
+def javadocDependentTasks = []
+
 subprojects {
   // Skip no-op project
   if (project.name == 'services') return
@@ -317,6 +321,10 @@ subprojects {
       }
     }
   }
+
+  javadocSource << project.sourceSets.main.allJava
+  javadocClasspath << project.sourceSets.main.compileClasspath
+  javadocDependentTasks << project.tasks.compileJava
 }
 
 // If "-P verboseTestOutput=true" is passed in, configure all subprojects to dump all of their
@@ -445,3 +453,18 @@ task javaIncrementalFormatApply {
 }
 
 tasks.build.dependsOn(tasks.javaIncrementalFormatCheck)
+
+task javadoc(type: Javadoc) {
+  source javadocSource
+  classpath = files(javadocClasspath)
+  destinationDir = file("${buildDir}/docs/javadoc")
+  // In a lot of places we don't write @return so suppress warnings about that.
+  options.addBooleanOption('Xdoclint:all,-missing', true)
+  options.addBooleanOption("-allow-script-in-comments",true)
+  options.tags = ["type:a:Generic Type",
+                  "error:a:Expected Error"]
+}
+
+tasks.build.dependsOn(tasks.javadoc)
+
+javadocDependentTasks.each { tasks.javadoc.shouldRunAfter(it) }

common/src/main/java/google/registry/util/Sleeper.java

@@ -21,7 +21,6 @@ import org.joda.time.ReadableDuration;
  * An object which accepts requests to put the current thread to sleep.
  *
  * @see SystemSleeper
- * @see google.registry.testing.FakeSleeper
  */
 @ThreadSafe
 public interface Sleeper {

core/src/main/java/google/registry/bigquery/BigqueryConnection.java

@@ -442,10 +442,8 @@ public class BigqueryConnection implements AutoCloseable {
    * Returns the result of calling queryToLocalTable, but synchronously to avoid spawning new
    * background threads, which App Engine doesn't support.
    *
-   * @see <a href="https://cloud.google.com/appengine/docs/standard/java/runtime#Threads">
+   * @see <a href="https://cloud.google.com/appengine/docs/standard/java/runtime#Threads">App Engine
-   *   App Engine Runtime</a>
+   *     Runtime</a>
-   *
-   * <p>Returns the results of the query in an ImmutableTable on success.
    */
   public ImmutableTable<Integer, TableFieldSchema, Object> queryToLocalTableSync(String querySql) {
     Job job = new Job()
@@ -576,8 +574,6 @@ public class BigqueryConnection implements AutoCloseable {
 
   /**
    * Launch a job, wait for it to complete, but <i>do not</i> check for errors.
-   *
-   * @throws BigqueryJobFailureException
    */
   public Job runJob(Job job, @Nullable AbstractInputStreamContent data) {
     return checkJob(waitForJob(launchJob(job, data)));

core/src/main/java/google/registry/dns/writer/dnsupdate/DnsMessageTransport.java

@@ -84,7 +84,7 @@ public class DnsMessageTransport {
    * @param query a message to send
    * @return the response received from the server
    * @throws IOException if the Socket input/output streams throws one
-   * @throws IllegalArgumentException if the query is too large to be sent (> 65535 bytes)
+   * @throws IllegalArgumentException if the query is too large to be sent (> 65535 bytes)
    */
   public Message send(Message query) throws IOException {
     try (Socket socket = factory.createSocket(InetAddress.getByName(updateHost), DNS_PORT)) {

core/src/main/java/google/registry/flows/EppXmlSanitizer.java

@@ -42,8 +42,8 @@ import javax.xml.stream.events.XMLEvent;
 /**
  * Sanitizes sensitive data in incoming/outgoing EPP XML messages.
  *
- * <p>Current implementation masks user credentials (text following <pw> and <newPW> tags) as
+ * <p>Current implementation masks user credentials (text following &lt;pw&gt; and &lt;newPW&gt;
- * follows:
+ * tags) as follows:
  *
  * <ul>
  *   <li>A control character (in ranges [0 - 1F] and [7F - 9F]) is replaced with 'C'.

core/src/main/java/google/registry/flows/custom/DomainCheckFlowCustomLogic.java

@@ -75,7 +75,7 @@ public class DomainCheckFlowCustomLogic extends BaseFlowCustomLogic {
 
     /**
      * The time to perform the domain check as of. This defaults to the current time, but can be
-     * overridden in v>=0.12 of the fee extension.
+     * overridden in v>=0.12 of the fee extension.
      */
     public abstract DateTime asOfDate();
 
@@ -105,7 +105,7 @@ public class DomainCheckFlowCustomLogic extends BaseFlowCustomLogic {
 
     /**
      * The time to perform the domain check as of. This defaults to the current time, but can be
-     * overridden in v>=0.12 of the fee extension.
+     * overridden in v>=0.12 of the fee extension.
      */
     public abstract DateTime asOfDate();
 

core/src/main/java/google/registry/model/OteStats.java

@@ -50,7 +50,8 @@ import java.util.stream.Collectors;
 public class OteStats {
 
   /**
-   * Returns the statistics about the OT&E actions that have been taken by a particular registrar.
+   * Returns the statistics about the OT&E actions that have been taken by a particular
+   * registrar.
    */
   public static OteStats getFromRegistrar(String registrarName) {
     return new OteStats().recordRegistrarHistory(registrarName);

core/src/main/java/google/registry/model/UpdateAutoTimestamp.java

@@ -30,7 +30,7 @@ public class UpdateAutoTimestamp extends ImmutableObject {
 
   DateTime timestamp;
 
-  /** Returns the timestamp, or {@link START_OF_TIME} if it's null. */
+  /** Returns the timestamp, or {@code START_OF_TIME} if it's null. */
   public DateTime getTimestamp() {
     return Optional.ofNullable(timestamp).orElse(START_OF_TIME);
   }

core/src/main/java/google/registry/model/contact/ContactCommand.java

@@ -37,7 +37,7 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 /** A collection of {@link ContactResource} commands. */
 public class ContactCommand {
 
-  /** The fields on "chgType" from {@link "http://tools.ietf.org/html/rfc5733"}. */
+  /** The fields on "chgType" from <a href="http://tools.ietf.org/html/rfc5733">RFC5733</a>. */
   @XmlTransient
   public static class ContactCreateOrChange extends ImmutableObject
       implements ResourceCreateOrChange<ContactResource.Builder> {
@@ -111,8 +111,8 @@ public class ContactCommand {
   }
 
   /**
-   * A create command for a {@link ContactResource}, mapping "createType" from
+   * A create command for a {@link ContactResource}, mapping "createType" from <a
-   * {@link "http://tools.ietf.org/html/rfc5733"}.
+   * href="http://tools.ietf.org/html/rfc5733">RFC5733</a>}.
    */
   @XmlType(propOrder = {"contactId", "postalInfo", "voice", "fax", "email", "authInfo", "disclose"})
   @XmlRootElement

core/src/main/java/google/registry/model/contact/Disclose.java

@@ -27,7 +27,7 @@ import javax.persistence.Embedded;
 import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlType;
 
-/** The "discloseType" from {@link "http://tools.ietf.org/html/rfc5733"}. */
+/** The "discloseType" from <a href="http://tools.ietf.org/html/rfc5733">RFC5733</a>. */
 @Embed
 @Embeddable
 @XmlType(propOrder = {"name", "org", "addr", "voice", "fax", "email"})
@@ -76,7 +76,7 @@ public class Disclose extends ImmutableObject {
     return flag;
   }
 
-  /** The "intLocType" from {@link "http://tools.ietf.org/html/rfc5733"}. */
+  /** The "intLocType" from <a href="http://tools.ietf.org/html/rfc5733">RFC5733</a>. */
   @Embed
   public static class PostalInfoChoice extends ImmutableObject {
     @XmlAttribute

core/src/main/java/google/registry/model/contact/PostalInfo.java

@@ -32,8 +32,8 @@ import javax.xml.bind.annotation.adapters.NormalizedStringAdapter;
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 
 /**
- * Implementation of both "postalInfoType" and "chgPostalInfoType" from {@link
+ * Implementation of both "postalInfoType" and "chgPostalInfoType" from <a href=
- * "http://tools.ietf.org/html/rfc5733"}.
+ * "http://tools.ietf.org/html/rfc5733">RFC5733</a>.
  */
 @Embed
 @Embeddable

core/src/main/java/google/registry/model/domain/DomainCommand.java

@@ -72,10 +72,10 @@ public class DomainCommand {
     T cloneAndLinkReferences(DateTime now) throws InvalidReferencesException;
   }
 
-  /** The fields on "chgType" from {@link "http://tools.ietf.org/html/rfc5731"}. */
+  /** The fields on "chgType" from <a href="http://tools.ietf.org/html/rfc5731">RFC5731</a>. */
   @XmlTransient
-  public static class DomainCreateOrChange<B extends DomainBase.Builder>
+  public static class DomainCreateOrChange<B extends DomainBase.Builder> extends ImmutableObject
-      extends ImmutableObject implements ResourceCreateOrChange<B> {
+      implements ResourceCreateOrChange<B> {
 
     /** The contactId of the registrant who registered this domain. */
     @XmlElement(name = "registrant")
@@ -103,19 +103,20 @@ public class DomainCommand {
   }
 
   /**
-   * A create command for a {@link DomainBase}, mapping "createType" from
+   * A create command for a {@link DomainBase}, mapping "createType" from <a
-   * {@link "http://tools.ietf.org/html/rfc5731"}.
+   * href="http://tools.ietf.org/html/rfc5731">RFC5731</a>.
    */
   @XmlRootElement
-  @XmlType(propOrder = {
+  @XmlType(
+      propOrder = {
         "fullyQualifiedDomainName",
         "period",
         "nameserverFullyQualifiedHostNames",
         "registrantContactId",
         "foreignKeyedDesignatedContacts",
-      "authInfo"})
+        "authInfo"
-  public static class Create
+      })
-      extends DomainCreateOrChange<DomainBase.Builder>
+  public static class Create extends DomainCreateOrChange<DomainBase.Builder>
       implements CreateOrUpdate<Create> {
 
     /** Fully qualified domain name, which serves as a unique identifier for this domain. */

core/src/main/java/google/registry/model/domain/Period.java

@@ -20,7 +20,7 @@ import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlEnumValue;
 import javax.xml.bind.annotation.XmlValue;
 
-/** The "periodType" from {@link "http://tools.ietf.org/html/rfc5731"}. */
+/** The "periodType" from <a href="http://tools.ietf.org/html/rfc5731">RFC5731</a>. */
 @Embed
 @javax.persistence.Embeddable
 public class Period extends ImmutableObject {

core/src/main/java/google/registry/model/domain/fee12/FeeCheckCommandExtensionItemV12.java

@@ -29,11 +29,13 @@ import org.joda.time.DateTime;
  * An individual price check item in version 0.12 of the fee extension on domain check commands.
  * Items look like:
  *
+ * <pre>{@code
  * <fee:command name="renew" phase="sunrise" subphase="hello">
  *   <fee:period unit="y">1</fee:period>
  *   <fee:class>premium</fee:class>
  *   <fee:date>2017-05-17T13:22:21.0Z</fee:date>
  * </fee:command>
+ * }</pre>
  *
  * In a change from previous versions of the extension, items do not contain domain names; instead,
  * the names from the non-extension check element are used.

core/src/main/java/google/registry/model/domain/launch/LaunchNotice.java

@@ -95,9 +95,6 @@ public class LaunchNotice extends ImmutableObject {
 
   /**
    * Validate the checksum of the notice against the domain label.
-   *
-   * @throws IllegalArgumentException
-   * @throws InvalidChecksumException
    */
   public void validate(String domainLabel) throws InvalidChecksumException {
     // According to http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.3, a TCNID

core/src/main/java/google/registry/model/domain/rgp/GracePeriodStatus.java

@@ -49,9 +49,9 @@ public enum GracePeriodStatus implements EppEnum {
   AUTO_RENEW("autoRenewPeriod"),
 
   /**
-   * This status value is used to describe a domain for which a <delete> command has been received,
+   * This status value is used to describe a domain for which a &lt;delete&gt; command has been
-   * but the domain has not yet been purged because an opportunity exists to restore the domain and
+   * received, but the domain has not yet been purged because an opportunity exists to restore the
-   * abort the deletion process.
+   * domain and abort the deletion process.
    */
   REDEMPTION("redemptionPeriod"),
 

core/src/main/java/google/registry/model/domain/token/AllocationTokenExtension.java

@@ -25,7 +25,7 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
  * An allocation token extension that may be present on EPP domain commands.
  *
  * @see <a href="https://tools.ietf.org/html/draft-ietf-regext-allocation-token-04">the IETF
- *     draft</a> for full details.
+ *     draft</a>
  */
 @XmlRootElement(name = "allocationToken")
 public class AllocationTokenExtension extends ImmutableObject implements CommandExtension {

core/src/main/java/google/registry/model/eppcommon/Address.java

@@ -44,8 +44,9 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 /**
  * Container for generic street address.
  *
- * <p>This is the "addrType" type from {@link "http://tools.ietf.org/html/rfc5733"}. It also matches
+ * <p>This is the "addrType" type from <a href="http://tools.ietf.org/html/rfc5733">RFC5733</a>. It
- * the "addrType" type from {@link "http://tools.ietf.org/html/draft-lozano-tmch-smd"}.
+ * also matches the "addrType" type from <a
+ * href="http://tools.ietf.org/html/draft-lozano-tmch-smd">Mark and Signed Mark Objects Mapping</a>.
  *
  * @see google.registry.model.contact.ContactAddress
  * @see google.registry.model.mark.MarkAddress

core/src/main/java/google/registry/model/eppcommon/PhoneNumber.java

@@ -29,8 +29,9 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 /**
  * Container for generic E164 phone number.
  *
- * <p>This is the "e164" type from {@link "http://tools.ietf.org/html/rfc5733"}. It also matches the
+ * <p>This is the "e164" type from <a href="http://tools.ietf.org/html/rfc5733">RFC5733</a>. It also
- * "e164Type" type from {@link "http://tools.ietf.org/html/draft-lozano-tmch-smd"}.
+ * matches the "e164Type" type from <a href="http://tools.ietf.org/html/draft-lozano-tmch-smd">Mark
+ * and Signed Mark Objects Mapping</a>
  *
  * <blockquote>
  *

core/src/main/java/google/registry/model/eppoutput/Greeting.java

@@ -24,7 +24,7 @@ import javax.xml.bind.annotation.XmlElementWrapper;
 import org.joda.time.DateTime;
 
 /**
- * A greeting, defined in {@link "http://tools.ietf.org/html/rfc5730"}.
+ * A greeting, defined in <a href="http://tools.ietf.org/html/rfc5730">RFC5730</a>.
  *
  * <p>It would be nice to make this a singleton, but we need the {@link #svDate} field to stay
  * current.

core/src/main/java/google/registry/model/host/HostCommand.java

@@ -32,7 +32,7 @@ import javax.xml.bind.annotation.XmlType;
 /** A collection of {@link HostResource} commands. */
 public class HostCommand {
 
-  /** The fields on "chgType" from {@link "http://tools.ietf.org/html/rfc5732"}. */
+  /** The fields on "chgType" from <a href="http://tools.ietf.org/html/rfc5732">RFC5732</a>. */
   @XmlTransient
   abstract static class HostCreateOrChange extends AbstractSingleResourceCommand
       implements ResourceCreateOrChange<HostResource.Builder> {
@@ -42,13 +42,13 @@ public class HostCommand {
   }
 
   /**
-   * A create command for a {@link HostResource}, mapping "createType" from
+   * A create command for a {@link HostResource}, mapping "createType" from <a
-   * {@link "http://tools.ietf.org/html/rfc5732"}.
+   * href="http://tools.ietf.org/html/rfc5732">RFC5732</a>.
    */
   @XmlType(propOrder = {"targetId", "inetAddresses"})
   @XmlRootElement
-  public static class Create
+  public static class Create extends HostCreateOrChange
-      extends HostCreateOrChange implements ResourceCreateOrChange<HostResource.Builder> {
+      implements ResourceCreateOrChange<HostResource.Builder> {
     /** IP Addresses for this host. Can be null if this is an external host. */
     @XmlElement(name = "addr")
     Set<InetAddress> inetAddresses;

core/src/main/java/google/registry/model/poll/PollMessage.java

@@ -62,7 +62,7 @@ import org.joda.time.DateTime;
  * <p>Poll messages are identified externally by registrars using the format defined in {@link
  * PollMessageExternalKeyConverter}.
  *
- * @see <a href="https://tools.ietf.org/html/rfc5730#section-2.9.2.3">RFC5730 - EPP - &ltpoll&gt
+ * @see <a href="https://tools.ietf.org/html/rfc5730#section-2.9.2.3">RFC5730 - EPP - &lt;poll&gt;
  *     Command</a>
  */
 @Entity

core/src/main/java/google/registry/model/registry/label/ReservedList.java

@@ -158,8 +158,8 @@ public final class ReservedList
   /**
    * Gets a ReservedList by name using the caching layer.
    *
-   * @return An Optional<ReservedList> that has a value if a reserved list exists by the given name,
+   * @return An Optional&lt;ReservedList&gt; that has a value if a reserved list exists by the given
-   *     or absent if not.
+   *     name, or absent if not.
    * @throws UncheckedExecutionException if some other error occurs while trying to load the
    *     ReservedList from the cache or Datastore.
    */

core/src/main/java/google/registry/model/reporting/IcannReportingTypes.java

@@ -22,8 +22,8 @@ public final class IcannReportingTypes {
    * Represents the set of possible ICANN Monthly Registry Functions Activity Report fields.
    *
    * <p>Refer to the <a
-   * href="https://newgtlds.icann.org/sites/default/files/agreements/agreement-approved-09jan14-en.htm#_DV_M278>ICANN
+   * href="https://newgtlds.icann.org/sites/default/files/agreements/agreement-approved-09jan14-en.htm#_DV_M278">
-   * registry agreement Specification 3 Section 2</a> for details.
+   * ICANN registry agreement Specification 3 Section 2</a> for details.
    */
   public enum ActivityReportField {
     DOMAIN_CHECK("srs-dom-check"),

core/src/main/java/google/registry/persistence/converter/BillingCostTransitionConverter.java

@@ -15,7 +15,6 @@
 package google.registry.persistence.converter;
 
 import avro.shaded.com.google.common.collect.Maps;
-import google.registry.model.common.TimedTransitionProperty;
 import google.registry.model.registry.Registry.BillingCostTransition;
 import java.util.Map;
 import javax.persistence.Converter;
@@ -23,8 +22,8 @@ import org.joda.money.Money;
 import org.joda.time.DateTime;
 
 /**
- * JPA converter for storing/retrieving {@link TimedTransitionProperty <Money, BillingCostTransition
+ * JPA converter for storing/retrieving {@code TimedTransitionProperty<Money,BillingCostTransition>}
- * >} objects.
+ * objects.
  */
 @Converter(autoApply = true)
 public class BillingCostTransitionConverter

core/src/main/java/google/registry/persistence/converter/CidrAddressBlockListConverter.java

@@ -15,12 +15,11 @@
 package google.registry.persistence.converter;
 
 import google.registry.util.CidrAddressBlock;
-import java.util.List;
 import javax.persistence.AttributeConverter;
 import javax.persistence.Converter;
 
 /**
- * JPA {@link AttributeConverter} for storing/retrieving {@link List<CidrAddressBlock>} objects.
+ * JPA {@link AttributeConverter} for storing/retrieving {@code List<CidrAddressBlock>} objects.
  * TODO(shicong): Investigate if we can have one converter for any List type
  */
 @Converter(autoApply = true)

core/src/main/java/google/registry/persistence/converter/CurrencyToBillingConverter.java

@@ -21,7 +21,7 @@ import java.util.Map;
 import javax.persistence.Converter;
 import org.joda.money.CurrencyUnit;
 
-/** JPA converter for storing/retrieving {@link Map <CurrencyUnit, BillingAccountEntry>} objects. */
+/** JPA converter for storing/retrieving {@code Map<CurrencyUnit, BillingAccountEntry>} objects. */
 @Converter(autoApply = true)
 public class CurrencyToBillingConverter
     extends StringMapConverterBase<CurrencyUnit, BillingAccountEntry> {

core/src/main/java/google/registry/persistence/converter/PostalInfoChoiceListConverter.java

@@ -16,11 +16,10 @@ package google.registry.persistence.converter;
 
 import google.registry.model.contact.Disclose.PostalInfoChoice;
 import google.registry.model.contact.PostalInfo;
-import java.util.List;
 import javax.persistence.AttributeConverter;
 import javax.persistence.Converter;
 
-/** JPA {@link AttributeConverter} for storing/retrieving {@link List < PostalInfoChoice >}. */
+/** JPA {@link AttributeConverter} for storing/retrieving {@code List<PostalInfoChoice>}. */
 @Converter(autoApply = true)
 public class PostalInfoChoiceListConverter extends StringListConverterBase<PostalInfoChoice> {
 

core/src/main/java/google/registry/persistence/converter/RegistrarPocSetConverter.java

@@ -15,11 +15,10 @@
 package google.registry.persistence.converter;
 
 import google.registry.model.registrar.RegistrarContact.Type;
-import java.util.Set;
 import javax.persistence.AttributeConverter;
 import javax.persistence.Converter;
 
-/** JPA {@link AttributeConverter} for storing/retrieving {@link Set<Type>}. */
+/** JPA {@link AttributeConverter} for storing/retrieving {@code Set<Type>}. */
 @Converter(autoApply = true)
 public class RegistrarPocSetConverter extends StringSetConverterBase<Type> {
   @Override

core/src/main/java/google/registry/persistence/converter/StatusValueSetConverter.java

@@ -15,11 +15,10 @@
 package google.registry.persistence.converter;
 
 import google.registry.model.eppcommon.StatusValue;
-import java.util.Set;
 import javax.persistence.AttributeConverter;
 import javax.persistence.Converter;
 
-/** JPA {@link AttributeConverter} for storing/retrieving {@link Set<StatusValue>}. */
+/** JPA {@link AttributeConverter} for storing/retrieving {@code Set<StatusValue>}. */
 @Converter(autoApply = true)
 public class StatusValueSetConverter extends StringSetConverterBase<StatusValue> {
 

core/src/main/java/google/registry/persistence/converter/StringCollectionDescriptor.java

@@ -37,7 +37,7 @@ import org.hibernate.type.descriptor.sql.SqlTypeDescriptor;
 /**
  * The {@link JavaTypeDescriptor} and {@link SqlTypeDescriptor} for {@link StringCollection}.
  *
- * <p>A {@link StringCollection} object is a simple wrapper for a {@link Collection<String>} which
+ * <p>A {@link StringCollection} object is a simple wrapper for a {@code Collection<String>} which
  * can be stored as a string array in the database. The {@link JavaTypeDescriptor} and {@link
  * SqlTypeDescriptor} is used by JPA/Hibernate to map between the collection and {@link Array} which
  * is the actual type that JDBC uses to read from and write to the database.

core/src/main/java/google/registry/persistence/converter/StringListConverter.java

@@ -14,11 +14,10 @@
 
 package google.registry.persistence.converter;
 
-import java.util.List;
 import javax.persistence.AttributeConverter;
 import javax.persistence.Converter;
 
-/** JPA {@link AttributeConverter} for storing/retrieving {@link List<String>}. */
+/** JPA {@link AttributeConverter} for storing/retrieving {@code List<String>}. */
 @Converter(autoApply = true)
 public class StringListConverter extends StringListConverterBase<String> {
 

core/src/main/java/google/registry/persistence/converter/StringMapDescriptor.java

@@ -36,7 +36,7 @@ import org.hibernate.type.descriptor.sql.SqlTypeDescriptor;
 /**
  * The {@link JavaTypeDescriptor} and {@link SqlTypeDescriptor} for {@link StringMap}.
  *
- * <p>A {@link StringMap} object is a simple wrapper for a {@link Map <String, String>} which can be
+ * <p>A {@link StringMap} object is a simple wrapper for a {@code Map<String, String>} which can be
  * stored in a column with data type of hstore in the database. The {@link JavaTypeDescriptor} and
  * {@link SqlTypeDescriptor} is used by JPA/Hibernate to map between the map and hstore which is the
  * actual type that JDBC uses to read from and write to the database.
@@ -156,7 +156,7 @@ public class StringMapDescriptor extends AbstractTypeDescriptor<StringMap>
     };
   }
 
-  /** A simple wrapper class for {@link Map<String, String>}. */
+  /** A simple wrapper class for {@code Map<String, String>}. */
   public static class StringMap {
     private Map<String, String> map;
 
@@ -169,7 +169,7 @@ public class StringMapDescriptor extends AbstractTypeDescriptor<StringMap>
       return new StringMap(ImmutableMap.copyOf(map));
     }
 
-    /** Returns the underlying {@link Map<String, String>} object. */
+    /** Returns the underlying {@code Map<String, String>} object. */
     public Map<String, String> getMap() {
       return map;
     }

core/src/main/java/google/registry/persistence/converter/StringSetConverter.java

@@ -14,11 +14,10 @@
 
 package google.registry.persistence.converter;
 
-import java.util.Set;
 import javax.persistence.AttributeConverter;
 import javax.persistence.Converter;
 
-/** JPA {@link AttributeConverter} for storing/retrieving {@link Set<String>}. */
+/** JPA {@link AttributeConverter} for storing/retrieving {@code Set<String>}. */
 @Converter(autoApply = true)
 public class StringSetConverter extends StringSetConverterBase<String> {
 

core/src/main/java/google/registry/persistence/converter/TldStateTransitionConverter.java

@@ -15,7 +15,6 @@
 package google.registry.persistence.converter;
 
 import com.google.common.collect.Maps;
-import google.registry.model.common.TimedTransitionProperty;
 import google.registry.model.registry.Registry.TldState;
 import google.registry.model.registry.Registry.TldStateTransition;
 import java.util.Map;
@@ -23,7 +22,7 @@ import javax.persistence.Converter;
 import org.joda.time.DateTime;
 
 /**
- * JPA converter for storing/retrieving {@link TimedTransitionProperty<TldState,
+ * JPA converter for storing/retrieving {@code TimedTransitionProperty<TldState,
  * TldStateTransition>} objects.
  */
 @Converter(autoApply = true)

core/src/main/java/google/registry/persistence/transaction/TransactionManager.java

@@ -17,6 +17,7 @@ package google.registry.persistence.transaction;
 import com.google.common.collect.ImmutableCollection;
 import com.google.common.collect.ImmutableList;
 import google.registry.persistence.VKey;
+import java.util.NoSuchElementException;
 import java.util.Optional;
 import java.util.function.Supplier;
 import org.joda.time.DateTime;

core/src/main/java/google/registry/rdap/RdapDomainSearchAction.java

@@ -61,10 +61,9 @@ import javax.inject.Inject;
  *     (RDAP) Query Format</a>
  * @see <a href="http://tools.ietf.org/html/rfc7483">RFC 7483: JSON Responses for the Registration
  *     Data Access Protocol (RDAP)</a>
- *
- * TODO(guyben):This isn't required by the RDAP Technical Implementation Guide, and hence should be
- * deleted, at least until it's actually required.
  */
+// TODO: This isn't required by the RDAP Technical Implementation Guide, and hence should be
+// deleted, at least until it's actually required.
 @Action(
     service = Action.Service.PUBAPI,
     path = "/rdap/domains",

core/src/main/java/google/registry/rdap/RdapEntitySearchAction.java

@@ -72,10 +72,9 @@ import javax.inject.Inject;
  *     (RDAP) Query Format</a>
  * @see <a href="http://tools.ietf.org/html/rfc7483">RFC 7483: JSON Responses for the Registration
  *     Data Access Protocol (RDAP)</a>
- *
- * TODO(guyben):This isn't required by the RDAP Technical Implementation Guide, and hence should be
- * deleted, at least until it's actually required.
  */
+// TODO: This isn't required by the RDAP Technical Implementation Guide, and hence should be
+// deleted, at least until it's actually required.
 @Action(
     service = Action.Service.PUBAPI,
     path = "/rdap/entities",

core/src/main/java/google/registry/rdap/RdapSearchActionBase.java

@@ -221,10 +221,9 @@ public abstract class RdapSearchActionBase extends RdapActionBase {
    *
    * <p>This version handles a list of parameter values, all associated with the same name.
    *
-   * <p>Example: If the original parameters were "a=w&a=x&b=y&c=z", and this method is called with
+   * <p>Example: If the original parameters were "a=w&amp;a=x&amp;b=y&amp;c=z", and this method is
-   * parameterName = "b" and parameterValues of "p" and "q", the result will be
+   * called with parameterName = "b" and parameterValues of "p" and "q", the result will be
-   * "a=w&a=x&c=z&b=p&b=q". The new values of parameter "b" replace the old ones.
+   * "a=w&amp;a=x&amp;c=z&amp;b=p&amp;b=q". The new values of parameter "b" replace the old ones.
-   *
    */
   protected String getRequestUrlWithExtraParameter(
       String parameterName, List<String> parameterValues) {

core/src/main/java/google/registry/rde/Ghostryde.java

@@ -120,9 +120,6 @@ public final class Ghostryde {
 
   /**
    * Creates a ghostryde file from an in-memory byte array.
-   *
-   * @throws PGPException
-   * @throws IOException
    */
   public static byte[] encode(byte[] data, PGPPublicKey key)
       throws IOException, PGPException {
@@ -137,9 +134,6 @@ public final class Ghostryde {
 
   /**
    * Deciphers a ghostryde file from an in-memory byte array.
-   *
-   * @throws PGPException
-   * @throws IOException
    */
   public static byte[] decode(byte[] data, PGPPrivateKey key)
       throws IOException, PGPException {

core/src/main/java/google/registry/rde/RdeUtil.java

@@ -46,9 +46,6 @@ public final class RdeUtil {
   /**
    * Look at some bytes from {@code xmlInput} to ensure it appears to be a FULL XML deposit and
    * then use a regular expression to extract the watermark timestamp which is returned.
-   *
-   * @throws IOException
-   * @throws XmlException
    */
   public static DateTime peekWatermark(BufferedInputStream xmlInput)
       throws IOException, XmlException {

core/src/main/java/google/registry/reporting/billing/BillingEmailUtils.java

@@ -34,7 +34,7 @@ import javax.mail.internet.InternetAddress;
 import org.joda.time.YearMonth;
 
 /** Utility functions for sending emails involving monthly invoices. */
-class BillingEmailUtils {
+public class BillingEmailUtils {
 
   private final SendEmailService emailService;
   private final YearMonth yearMonth;

core/src/main/java/google/registry/reporting/billing/GenerateInvoicesAction.java

@@ -43,8 +43,8 @@ import org.joda.time.YearMonth;
  * PublishInvoicesAction} to publish the subsequent output.
  *
  * <p>This action runs the {@link google.registry.beam.invoicing.InvoicingPipeline} beam template,
- * staged at gs://<projectId>-beam/templates/invoicing. The pipeline then generates invoices for the
+ * staged at gs://&lt;projectId&gt;-beam/templates/invoicing. The pipeline then generates invoices
- * month and stores them on GCS.
+ * for the month and stores them on GCS.
  */
 @Action(
     service = Action.Service.BACKEND,

core/src/main/java/google/registry/reporting/spec11/PublishSpec11ReportAction.java

@@ -53,7 +53,7 @@ import org.json.JSONException;
  * pipeline accordingly.
  *
  * <p>This calls {@link Spec11EmailUtils#emailSpec11Reports(LocalDate, SoyTemplateInfo, String,
- * Set)} on success or {@link Spec11EmailUtils#sendAlertEmail(String, String)} on failure.
+ * ImmutableSet)} on success or {@link Spec11EmailUtils#sendAlertEmail(String, String)} on failure.
  */
 @Action(
     service = Action.Service.BACKEND,

core/src/main/java/google/registry/request/RequestParameters.java

@@ -45,9 +45,9 @@ public final class RequestParameters {
    *
    * <ul>
    *   <li>/foo?bar=hello → hello
-   *   <li>/foo?bar=hello&bar=there → hello
+   *   <li>/foo?bar=hello&amp;bar=there → hello
    *   <li>/foo?bar= → 400 error (empty)
-   *   <li>/foo?bar=&bar=there → 400 error (empty)
+   *   <li>/foo?bar=&amp;bar=there → 400 error (empty)
    *   <li>/foo → 400 error (absent)
    * </ul>
    *

core/src/main/java/google/registry/schema/cursor/CursorDao.java

@@ -59,7 +59,7 @@ public class CursorDao {
         .transact(() -> jpaTm().getEntityManager().find(Cursor.class, new CursorId(type, scope)));
   }
 
-  /** If no scope is given, use {@link Cursor.GLOBAL} as the scope. */
+  /** If no scope is given, use {@link Cursor#GLOBAL} as the scope. */
   public static Cursor load(CursorType type) {
     checkNotNull(type, "The type of the cursor to load must be specified");
     return load(type, Cursor.GLOBAL);

core/src/main/java/google/registry/schema/domain/RegistryLock.java

@@ -214,13 +214,13 @@ public final class RegistryLock extends ImmutableObject implements Buildable, Sq
     return lockCompletionTimestamp != null && unlockCompletionTimestamp == null;
   }
 
-  /** Returns true iff the lock was requested >= 1 hour ago and has not been verified. */
+  /** Returns true iff the lock was requested >= 1 hour ago and has not been verified. */
   public boolean isLockRequestExpired(DateTime now) {
     return !getLockCompletionTimestamp().isPresent()
         && isBeforeOrAt(getLockRequestTimestamp(), now.minusHours(1));
   }
 
-  /** Returns true iff the unlock was requested >= 1 hour ago and has not been verified. */
+  /** Returns true iff the unlock was requested >= 1 hour ago and has not been verified. */
   public boolean isUnlockRequestExpired(DateTime now) {
     Optional<DateTime> unlockRequestTimestamp = getUnlockRequestTimestamp();
     return unlockRequestTimestamp.isPresent()

core/src/main/java/google/registry/storage/drive/DriveConnection.java

@@ -42,7 +42,7 @@ public class DriveConnection {
   /**
    * Creates a folder with the given parent.
    *
-   * @returns the folder id.
+   * @return the folder id.
    */
   public String createFolder(String title, String parentFolderId) throws IOException {
     return drive.files()
@@ -58,7 +58,7 @@ public class DriveConnection {
    * existing file is the desired behavior, use {@link #createOrUpdateFile(String, MediaType,
    * String, byte[])} instead.
    *
-   * @returns the file id.
+   * @return the file id.
    */
   public String createFile(String title, MediaType mimeType, String parentFolderId, byte[] bytes)
       throws IOException {
@@ -76,13 +76,10 @@ public class DriveConnection {
    *
    * @throws IllegalStateException if multiple files with that name exist in the given folder.
    * @throws IOException if communication with Google Drive fails for any reason.
-   * @returns the file id.
+   * @return the file id.
    */
   public String createOrUpdateFile(
-      String title,
+      String title, MediaType mimeType, String parentFolderId, byte[] bytes) throws IOException {
-      MediaType mimeType,
-      String parentFolderId,
-      byte[] bytes) throws IOException {
     List<String> existingFiles = listFiles(parentFolderId, String.format("title = '%s'", title));
     if (existingFiles.size() > 1) {
       throw new IllegalStateException(String.format(
@@ -97,10 +94,10 @@ public class DriveConnection {
   }
 
   /**
-   * Updates the file with the given id in place, setting the title, content, and mime type to
+   * Updates the file with the given id in place, setting the title, content, and mime type to the
-   * the newly specified values.
+   * newly specified values.
    *
-   * @returns the file id.
+   * @return the file id.
    */
   public String updateFile(String fileId, String title, MediaType mimeType, byte[] bytes)
       throws IOException {

core/src/main/java/google/registry/tmch/TmchXmlSignature.java

@@ -77,10 +77,6 @@ public class TmchXmlSignature {
    *
    * @throws GeneralSecurityException for unsupported protocols, certs not signed by the TMCH,
    *     incorrect keys, and for invalid, old, not-yet-valid or revoked certificates.
-   * @throws IOException
-   * @throws MarshalException
-   * @throws ParserConfigurationException
-   * @throws SAXException
    */
   public void verify(byte[] smdXml)
       throws GeneralSecurityException, IOException, MarshalException, ParserConfigurationException,

core/src/main/java/google/registry/tools/LevelDbLogReader.java

@@ -36,17 +36,16 @@ import java.util.Optional;
  *
  * <p>The input source is automatically closed when all data have been read.
  *
- * <p>See <a
- * href="https://github.com/google/leveldb/blob/master/doc/log_format.md">log_format.md</a> for the
- * leveldb log format specification.</a>
- *
  * <p>There are several other implementations of this, none of which appeared suitable for our use
  * case: <a href="https://github.com/google/leveldb">The original C++ implementation</a>. <a
  * href="https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/files/RecordReadChannel">
  * com.google.appengine.api.files.RecordReadChannel</a> - Exactly what we need but deprecated. The
  * referenced replacement: <a
  * href="https://github.com/GoogleCloudPlatform/appengine-gcs-client.git">The App Engine GCS
- * Client</a> - Does not appear to have any support for working with LevelDB.
+ * Client</a> - Does not appear to have any support for working with LevelDB. *
+ *
+ * <p>See <a
+ * href="https://github.com/google/leveldb/blob/master/doc/log_format.md">log_format.md</a>
  */
 public final class LevelDbLogReader implements Iterator<byte[]> {
 

core/src/main/java/google/registry/ui/forms/FormField.java

@@ -44,8 +44,9 @@ import javax.annotation.concurrent.Immutable;
  * Declarative functional fluent form field converter / validator.
  *
  * <p>This class is responsible for converting arbitrary data, sent to us by the web browser, into
- * validated data structures that the server-side code can use. For example:<pre>
+ * validated data structures that the server-side code can use. For example:
  *
+ * <pre>{@code
  * private enum Gender { MALE, FEMALE }
  *
  * private static final FormField<String, String> NAME_FIELD = FormField.named("name")
@@ -68,6 +69,7 @@ import javax.annotation.concurrent.Immutable;
  *     person.setGender(name);
  *   }
  *   return person.build();
+ * }
  * }</pre>
  *
  * <p>This class provides <b>full type-safety</b> <i>if and only if</i> you statically initialize
@@ -75,12 +77,12 @@ import javax.annotation.concurrent.Immutable;
  *
  * <h3>Exception Handling</h3>
  *
- * <p>When values passed to {@link #convert} or {@link #extract} don't meet the contract,
+ * <p>When values passed to {@link #convert} or {@link #extract} don't meet the contract, {@link
- * {@link FormFieldException} will be thrown, which provides the field name and a short error
+ * FormFieldException} will be thrown, which provides the field name and a short error message
- * message that's safe to pass along to the client.
+ * that's safe to pass along to the client.
  *
- * <p>You can safely throw {@code FormFieldException} from within your validator functions, and
+ * <p>You can safely throw {@code FormFieldException} from within your validator functions, and the
- * the field name will automatically be propagated into the exception object for you.
+ * field name will automatically be propagated into the exception object for you.
  *
  * <p>In situations when you're validating lists or maps, you'll end up with a hierarchical field
  * naming structure. For example, if you were validating a list of maps, an error generated by the
@@ -92,8 +94,9 @@ import javax.annotation.concurrent.Immutable;
  * <p>You should never assign a partially constructed {@code FormField.Builder} to a variable or
  * constant. Instead, you should use {@link #asBuilder()} or {@link #asBuilderNamed(String)}.
  *
- * <p>Here is an example of how you might go about defining library definitions:<pre>
+ * <p>Here is an example of how you might go about defining library definitions:
  *
+ * <pre>{@code
  * final class FormFields {
  *   private static final FormField<String, String> COUNTRY_CODE =
  *       FormField.named("countryCode")
@@ -108,6 +111,7 @@ import javax.annotation.concurrent.Immutable;
  *       FormFields.COUNTRY_CODE.asBuilder()
  *           .required()
  *           .build();
+ * }
  * }</pre>
  *
  * @param <I> input value type

core/src/main/java/google/registry/ui/server/SendEmailUtils.java

@@ -105,9 +105,10 @@ public class SendEmailUtils {
     }
   }
 
-  /** Sends an email from Nomulus to the registrarChangesNotificationEmailAddresses.
+  /**
+   * Sends an email from Nomulus to the registrarChangesNotificationEmailAddresses.
    *
-   * <p>See {@link #sendEmail(String, String, ImmutableList<String>)}.
+   * <p>See {@link #sendEmail(String, String, ImmutableList)}.
    */
   public boolean sendEmail(final String subject, String body) {
     return sendEmail(subject, body, ImmutableList.of());

core/src/main/java/google/registry/whois/WhoisHttpAction.java

@@ -58,11 +58,9 @@ import org.joda.time.Duration;
  * <p>You can send AJAX requests to our WHOIS API from your <em>very own</em> website using the
  * following embed code:
  *
- * <pre>
+ * <pre>{@code
- *   <p>
  * <input id="query-input" placeholder="Domain, Nameserver, IP, etc." autofocus>
  * <button id="search-button">Lookup</button>
- *   <p>
  * <pre id="whois-results"></pre>
  * <script>
  *  (function() {
@@ -91,7 +89,7 @@ import org.joda.time.Duration;
  *    document.getElementById('query-input').onkeypress = OnKeyPressQueryInput;
  *  })();
  * </script>
- * </pre>
+ * }</pre>
  *
  * @see WhoisAction
  */

core/src/main/resources/google/registry/ui/soy/registrar/OteSetupConsole.soy

@@ -55,7 +55,7 @@
 {template .resultSuccess}
   {@param baseClientId: string} /** The base clientId used for the OT&E setup. */
   {@param contactEmail: string} /** The contact's email added to the registrars. */
-  {@param clientIdToTld: map<string, string>} /** The created registrars->TLD mapping. */
+  {@param clientIdToTld: map<string, string>} /** The created registrars-&gt;TLD mapping. */
   {@param password: string} /** The password given for the created registrars. */
   {@param username: string} /** Arbitrary username to display. */
   {@param logoutUrl: string} /** Generated URL for logging out of Google. */

prober/src/main/java/google/registry/monitoring/blackbox/ProbingSequence.java

@@ -33,8 +33,8 @@ import io.netty.channel.EventLoopGroup;
  * <p>Inherits from {@link CircularList}, with element type of {@link ProbingStep} as the manner in
  * which the sequence is carried out is similar to the {@link CircularList}. However, the {@link
  * Builder} of {@link ProbingSequence} override {@link CircularList.AbstractBuilder} allowing for
- * more customized flows, that are looped, but not necessarily entirely circular. Example: first ->
+ * more customized flows, that are looped, but not necessarily entirely circular. Example: first
- * second -> third -> fourth -> second -> third -> fourth -> second -> ...
+ * -&gt; second -&gt; third -&gt; fourth -&gt; second -&gt; third -&gt; fourth -&gt; second -&gt;...
  *
  * <p>Created with {@link Builder} where we specify {@link EventLoopGroup}, {@link AbstractChannel}
  * class type, then sequentially add in the {@link ProbingStep.Builder}s in order and mark which one

prober/src/main/java/google/registry/monitoring/blackbox/connection/ProbingAction.java

@@ -47,9 +47,8 @@ import org.joda.time.Duration;
 /**
  * AutoValue class that represents action generated by {@link ProbingStep}
  *
- * <p>Inherits from {@link Callable<ChannelFuture>}, as it has can be called to perform its
+ * <p>Inherits from {@link Callable}, as it has can be called to perform its specified task, and
- * specified task, and return the {@link ChannelFuture} that will be informed when the task has been
+ * return the {@link ChannelFuture} that will be informed when the task has been completed
- * completed
  *
  * <p>Is an immutable class, as it is comprised of the tools necessary for making a specific type of
  * connection. It goes hand in hand with {@link Protocol}, which specifies the kind of overall

prober/src/main/java/google/registry/monitoring/blackbox/handler/ActionHandler.java

@@ -27,8 +27,8 @@ import io.netty.channel.SimpleChannelInboundHandler;
 /**
  * Superclass of all {@link io.netty.channel.ChannelHandler}s placed at end of channel pipeline
  *
- * <p>{@link ActionHandler} inherits from {@link SimpleChannelInboundHandler<InboundMessageType>},
+ * <p>{@link ActionHandler} inherits from {@link SimpleChannelInboundHandler}, as it should only be
- * as it should only be passed in messages that implement the {@link InboundMessageType} interface.
+ * passed in messages that implement the {@link InboundMessageType} interface.
  *
  * <p>The {@link ActionHandler} skeleton exists for a few main purposes. First, it returns a {@link
  * ChannelPromise}, which informs the {@link ProbingAction} in charge that a response has been read.

prober/src/main/java/google/registry/monitoring/blackbox/handler/WebWhoisActionHandler.java

@@ -40,7 +40,7 @@ import org.joda.time.Duration;
  *
  * <p>Main purpose is to verify {@link HttpResponseMessage} received is valid. If the response
  * implies a redirection it follows the redirection until either an Error Response is received, or
- * {@link HttpResponseStatus.OK} is received
+ * {@link HttpResponseStatus#OK} is received
  */
 public class WebWhoisActionHandler extends ActionHandler {
 

prober/src/main/java/google/registry/monitoring/blackbox/message/EppMessage.java

@@ -209,8 +209,7 @@ public class EppMessage {
    * @param xml the XML Document containing the EPP reponse to verify
    * @param expressions a list of XPath expressions to query the document with.
    * @param validate a boolean flag to control if schema validation occurs (useful for testing)
-   * @throws IOException if InputStream throws one
+   * @throws FailureException if the EPP response cannot be read, parsed, or doesn't containing
-   * @throws EppClientException if the EPP response cannot be read, parsed, or doesn't containing
    *     matching data specified in expressions
    */
   protected static void verifyEppResponse(Document xml, List<String> expressions, boolean validate)
@@ -309,7 +308,7 @@ public class EppMessage {
    *
    * @param responseBuffer the byte array to transform
    * @return the resulting Document
-   * @throws EppClientException if the transform fails
+   * @throws FailureException if the transform fails
    */
   public static Document byteArrayToXmlDoc(byte[] responseBuffer) throws FailureException {
     Document xml;

prober/src/main/java/google/registry/monitoring/blackbox/message/EppRequestMessage.java

@@ -117,7 +117,7 @@ public class EppRequestMessage extends EppMessage implements OutboundMessageType
    *
    * @return the {@link ByteBuf} instance that stores the bytes representing the requisite EPP
    *     Request
-   * @throws EppClientException- On the occasion that the prober can't appropriately convert the EPP
+   * @throws EppClientException On the occasion that the prober can't appropriately convert the EPP
    *     XML document to a {@link ByteBuf}, the blame falls on the prober, not the server, so it
    *     throws an {@link EppClientException}, which is a subclass of the {@link
    *     UndeterminedStateException}.

proxy/src/main/java/google/registry/proxy/handler/EppServiceHandler.java

@@ -76,18 +76,19 @@ public class EppServiceHandler extends HttpsRelayServiceHandler {
   }
 
   /**
-   * Write <hello> to the server after SSL handshake completion to request <greeting>
+   * Write {@code <hello>} to the server after SSL handshake completion to request {@code
+   * <greeting>}
    *
-   * <p>When handling EPP over TCP, the server should issue a <greeting> to the client when a
+   * <p>When handling EPP over TCP, the server should issue a {@code <greeting>} to the client when
-   * connection is established. Nomulus app however does not automatically sends the <greeting> upon
+   * a connection is established. Nomulus app however does not automatically sends the {@code
-   * connection. The proxy therefore first sends a <hello> to registry to request a <greeting>
+   * <greeting>} upon connection. The proxy therefore first sends a {@code <hello>} to registry to
-   * response.
+   * request a {@code <greeting>} response.
    *
-   * <p>The <hello> request is only sent after SSL handshake is completed between the client and the
+   * <p>The {@code <hello>} request is only sent after SSL handshake is completed between the client
-   * proxy so that the client certificate hash is available, which is needed to communicate with the
+   * and the proxy so that the client certificate hash is available, which is needed to communicate
-   * server. Because {@link SslHandshakeCompletionEvent} is triggered before any calls to {@link
+   * with the server. Because {@link SslHandshakeCompletionEvent} is triggered before any calls to
-   * #channelRead} are scheduled by the event loop executor, the <hello> request is guaranteed to be
+   * {@link #channelRead} are scheduled by the event loop executor, the {@code <hello>} request is
-   * the first message sent to the server.
+   * guaranteed to be the first message sent to the server.
    *
    * @see <a href="https://tools.ietf.org/html/rfc5734">RFC 5732 EPP Transport over TCP</a>
    * @see <a href="https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">The Proxy

proxy/src/main/java/google/registry/proxy/handler/HttpsRelayServiceHandler.java

@@ -48,7 +48,7 @@ import javax.net.ssl.SSLHandshakeException;
  *
  * <p>This handler reads in a {@link ByteBuf}, converts it to an {@link FullHttpRequest}, and passes
  * it to the {@code channelRead} method of the next inbound handler the channel pipeline, which is
- * usually a {@link RelayHandler<FullHttpRequest>}. The relay handler writes the request to the
+ * usually a {@code RelayHandler<FullHttpRequest>}. The relay handler writes the request to the
  * relay channel, which is connected to an HTTPS endpoint. After the relay channel receives a {@link
  * FullHttpResponse} back, its own relay handler writes the response back to this channel, which is
  * the relay channel of the relay channel. This handler then handles write request by encoding the

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>tools.projectid.appspot.com --&gt; tools-dot-projectid.appspot.com
-   *   <li>version.backend.projectid.appspot.com --> version-dot-backend-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 *
+ * <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 *
+ * 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 *
+ * 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-&gt;field map. */
-   * Aggregates enum "values" in a typesafe enum pattern into a string->field map.
-   */
   @SuppressWarnings("unchecked")
   public static <T> ImmutableMap<String, T> getTypesafeEnumMapping(Class<T> clazz) {
     ImmutableMap.Builder<String, T> builder = new ImmutableMap.Builder<>();