diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 9657d8ad9..5f30f41d0 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -54,6 +54,9 @@ jobs: - name: Check run: ./gradlew check + - name: Generate Javadocs + run: ./gradlew :core:javadoc :android:javaDocReleaseGeneration + integration: runs-on: ubuntu-latest if: github.repository == 'dropbox/dropbox-sdk-java' && github.ref == 'refs/heads/main' && github.event_name != 'pull_request' diff --git a/core/build.gradle b/core/build.gradle index 06cf5e7a5..165386c43 100644 --- a/core/build.gradle +++ b/core/build.gradle @@ -207,13 +207,14 @@ tasks.named("javadoc", Javadoc) { title = "${project.mavenName} ${versionName} API" failOnError = true - // JDK 8's javadoc has an on-by-default lint called "missing", which requires that everything - // be documented. Disable this lint because we intentionally don't document some things. + // JDK's javadoc has on-by-default lints for missing docs and unresolved references. Disable + // these because we intentionally don't document some things and generated/cross-module links + // are not always resolvable in this standalone Javadoc task. // // NOTE: ugly hack to set our doclint settings due to strange handling of string options by the // javadoc task. if (JavaVersion.current().isJava8Compatible()) { - options.addBooleanOption "Xdoclint:all,-missing", true + options.addBooleanOption "Xdoclint:all,-missing,-reference", true } options.addStringOption "link", "http://docs.oracle.com/javase/8/docs/api/" } diff --git a/core/src/main/java/com/dropbox/core/DbxWebAuth.java b/core/src/main/java/com/dropbox/core/DbxWebAuth.java index 4baef1f07..e9dc22da2 100644 --- a/core/src/main/java/com/dropbox/core/DbxWebAuth.java +++ b/core/src/main/java/com/dropbox/core/DbxWebAuth.java @@ -24,7 +24,7 @@ * for a user when they first use your application. Once you have an access token for that user, it * remains valid for years. * - *

Redirect example

+ *

Redirect example

*

One-time setup typically done on server initialization:

*
  *     {@link DbxRequestConfig} requestConfig = new DbxRequestConfig("text-edit/0.1");
@@ -34,7 +34,7 @@
  *     String redirectUri = "http://my-server.com/dropbox-auth-finish";
  * 
* - *

Part 1

+ *

Part 1

*

Handler for "http://my-server.com/dropbox-auth-start":

*
  *     {@link jakarta.servlet.http.HttpServletRequest} request = ...
@@ -59,7 +59,7 @@
  *     response.sendRedirect(authorizePageUrl);
  * 
* - *

Part 2

+ *

Part 2

*

Handler for "http://my-server.com/dropbox-auth-finish":

*
  *     {@link jakarta.servlet.http.HttpServletRequest} request = ...
@@ -111,7 +111,7 @@
  *     ...
  * 
* - *

No Redirect Example

+ *

No Redirect Example

* *
  *     {@link DbxRequestConfig} requestConfig = new DbxRequestConfig("text-edit/0.1");