diff --git a/build.gradle b/build.gradle index 1bf323328..ce40bf863 100644 --- a/build.gradle +++ b/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) } diff --git a/common/src/main/java/google/registry/util/Sleeper.java b/common/src/main/java/google/registry/util/Sleeper.java index 12e5d48ab..288b0862a 100644 --- a/common/src/main/java/google/registry/util/Sleeper.java +++ b/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 { diff --git a/core/src/main/java/google/registry/bigquery/BigqueryConnection.java b/core/src/main/java/google/registry/bigquery/BigqueryConnection.java index cc265d280..9a5bfd396 100644 --- a/core/src/main/java/google/registry/bigquery/BigqueryConnection.java +++ b/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 - * App Engine Runtime - * - *

Returns the results of the query in an ImmutableTable on success. + * @see App Engine + * Runtime */ public ImmutableTable 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 do not check for errors. - * - * @throws BigqueryJobFailureException */ public Job runJob(Job job, @Nullable AbstractInputStreamContent data) { return checkJob(waitForJob(launchJob(job, data))); diff --git a/core/src/main/java/google/registry/dns/writer/dnsupdate/DnsMessageTransport.java b/core/src/main/java/google/registry/dns/writer/dnsupdate/DnsMessageTransport.java index 151b03bfc..79f9950d4 100644 --- a/core/src/main/java/google/registry/dns/writer/dnsupdate/DnsMessageTransport.java +++ b/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)) { diff --git a/core/src/main/java/google/registry/flows/EppXmlSanitizer.java b/core/src/main/java/google/registry/flows/EppXmlSanitizer.java index ee20afe71..af5ba6147 100644 --- a/core/src/main/java/google/registry/flows/EppXmlSanitizer.java +++ b/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. * - *

Current implementation masks user credentials (text following and tags) as - * follows: + *

Current implementation masks user credentials (text following <pw> and <newPW> + * tags) as follows: * *