Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
7 changes: 4 additions & 3 deletions core/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
}
Expand Down
8 changes: 4 additions & 4 deletions core/src/main/java/com/dropbox/core/DbxWebAuth.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <h1> Redirect example </h1>
* <h2> Redirect example </h2>
* <p> One-time setup typically done on server initialization: </p>
* <pre>
* {@link DbxRequestConfig} requestConfig = new DbxRequestConfig("text-edit/0.1");
Expand All @@ -34,7 +34,7 @@
* String redirectUri = "http://my-server.com/dropbox-auth-finish";
* </pre>
*
* <h2> Part 1 </h2>
* <h3> Part 1 </h3>
* <p> Handler for "http://my-server.com/dropbox-auth-start": </p>
* <pre>
* {@link jakarta.servlet.http.HttpServletRequest} request = ...
Expand All @@ -59,7 +59,7 @@
* response.sendRedirect(authorizePageUrl);
* </pre>
*
* <h2> Part 2 </h2>
* <h3> Part 2 </h3>
* <p> Handler for "http://my-server.com/dropbox-auth-finish": </p>
* <pre>
* {@link jakarta.servlet.http.HttpServletRequest} request = ...
Expand Down Expand Up @@ -111,7 +111,7 @@
* ...
* </pre>
*
* <h1> No Redirect Example </h1>
* <h2> No Redirect Example </h2>
*
* <pre>
* {@link DbxRequestConfig} requestConfig = new DbxRequestConfig("text-edit/0.1");
Expand Down
Loading