docs: update javadoc sample code comments to render correctly in Cloud RAD (#1121)

alicejli · burkedavison · web-flow · commit ab4d5e7dae92 · 2024-10-28T17:01:56.000-04:00
Co-authored-by: Burke Davison &lt;40617934+burkedavison@users.noreply.github.com&gt;
diff --git a/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/AbstractAppEngineAuthorizationCodeCallbackServlet.java b/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/AbstractAppEngineAuthorizationCodeCallbackServlet.java
@@ -43,7 +43,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public class ServletCallbackSample extends AbstractAppEngineAuthorizationCodeCallbackServlet {
  *
  * &#64;Override
@@ -77,7 +77,7 @@
  * "https://server.example.com/authorize").setCredentialStore(new AppEngineCredentialStore())
  * .build();
  * }
- * </pre>
+ * }</pre>
  *
  * @since 1.7
  * @author Yaniv Inbar
diff --git a/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/AbstractAppEngineAuthorizationCodeServlet.java b/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/AbstractAppEngineAuthorizationCodeServlet.java
@@ -43,7 +43,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public class ServletSample extends AbstractAppEngineAuthorizationCodeServlet {
  *
  * &#64;Override
@@ -71,7 +71,7 @@
  * .build();
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * @since 1.7
  * @author Yaniv Inbar
diff --git a/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/AppEngineCredentialStore.java b/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/AppEngineCredentialStore.java
@@ -84,14 +84,14 @@ public boolean load(String userId, Credential credential) {
    *
    * <p>Sample usage:
    *
-   * <pre>
+   * <pre>{@code
    * public static AppEngineDataStore migrate(AppEngineCredentialStore credentialStore)
    * throws IOException {
    * AppEngineDataStore dataStore = new AppEngineDataStore();
    * credentialStore.migrateTo(dataStore);
    * return dataStore;
    * }
-   * </pre>
+   * }</pre>
    *
    * @param dataStoreFactory App Engine data store factory
    * @since 1.16
diff --git a/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/jakarta/AbstractAppEngineAuthorizationCodeCallbackServlet.java b/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/jakarta/AbstractAppEngineAuthorizationCodeCallbackServlet.java
@@ -43,7 +43,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public class ServletCallbackSample extends AbstractAppEngineAuthorizationCodeCallbackServlet {
  *
  * &#64;Override
@@ -77,7 +77,7 @@
  * "https://server.example.com/authorize").setCredentialStore(new AppEngineCredentialStore())
  * .build();
  * }
- * </pre>
+ * }</pre>
  *
  * @since 1.36.0
  */
diff --git a/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/jakarta/AbstractAppEngineAuthorizationCodeServlet.java b/google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/jakarta/AbstractAppEngineAuthorizationCodeServlet.java
@@ -43,7 +43,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public class ServletSample extends AbstractAppEngineAuthorizationCodeServlet {
  *
  * &#64;Override
@@ -71,7 +71,7 @@
  * .build();
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * @since 1.36.0
  */
diff --git a/google-oauth-client-java6/src/main/java/com/google/api/client/extensions/java6/auth/oauth2/FileCredentialStore.java b/google-oauth-client-java6/src/main/java/com/google/api/client/extensions/java6/auth/oauth2/FileCredentialStore.java
@@ -174,14 +174,14 @@ private void save() throws IOException {
    *
    * <p>Sample usage:
    *
-   * <pre>
+   * <pre>{@code
    * public static FileDataStore migrate(FileCredentialStore credentialStore, File dataDirectory)
    * throws IOException {
    * FileDataStore dataStore = new FileDataStore(dataDirectory);
    * credentialStore.migrateTo(dataStore);
    * return dataStore;
    * }
-   * </pre>
+   * }</pre>
    *
    * @param dataStoreFactory file data store factory
    * @throws IOException
diff --git a/google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/AbstractAuthorizationCodeCallbackServlet.java b/google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/AbstractAuthorizationCodeCallbackServlet.java
@@ -40,7 +40,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public class ServletCallbackSample extends AbstractAuthorizationCodeCallbackServlet {
  *
  * &#64;Override
@@ -81,7 +81,7 @@
  * // return user ID
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * @since 1.7
  * @author Yaniv Inbar
diff --git a/google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/AbstractAuthorizationCodeServlet.java b/google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/AbstractAuthorizationCodeServlet.java
@@ -49,7 +49,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public class ServletSample extends AbstractAuthorizationCodeServlet {
  *
  * &#64;Override
@@ -83,7 +83,7 @@
  * // return user ID
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * @since 1.7
  * @author Yaniv Inbar
diff --git a/google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/jakarta/AbstractAuthorizationCodeCallbackServlet.java b/google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/jakarta/AbstractAuthorizationCodeCallbackServlet.java
@@ -40,7 +40,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public class ServletCallbackSample extends AbstractAuthorizationCodeCallbackServlet {
  *
  * &#64;Override
@@ -81,7 +81,7 @@
  * // return user ID
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * @since 1.36.0
  */
diff --git a/google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/jakarta/AbstractAuthorizationCodeServlet.java b/google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/jakarta/AbstractAuthorizationCodeServlet.java
@@ -49,7 +49,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public class ServletSample extends AbstractAuthorizationCodeServlet {
  *
  * &#64;Override
@@ -83,7 +83,7 @@
  * // return user ID
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * @since 1.36.0
  */
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth/OAuthParameters.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth/OAuthParameters.java
@@ -41,13 +41,13 @@
  *
  * <p>Sample usage, taking advantage that this class implements {@link HttpRequestInitializer}:
  *
- * <pre>
+ * <pre>{@code
  * public static HttpRequestFactory createRequestFactory(HttpTransport transport) {
  * OAuthParameters parameters = new OAuthParameters();
  * // ...
  * return transport.createRequestFactory(parameters);
  * }
- * </pre>
+ * }</pre>
  *
  * <p>If you have a custom request initializer, take a look at the sample usage for {@link
  * HttpExecuteInterceptor}, which this class also implements.
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationCodeFlow.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationCodeFlow.java
@@ -174,15 +174,15 @@ protected AuthorizationCodeFlow(Builder builder) {
    * the {@link #getAuthorizationServerEncodedUrl()}, {@link #getClientId()}, and {@link
    * #getScopes()}. Sample usage:
    *
-   * <pre>
+   * <pre>{@code
    * private AuthorizationCodeFlow flow;
    *
    * public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
    * String url = flow.newAuthorizationUrl().setState("xyz")
    * .setRedirectUri("https://client.example.com/rd").build();
    * response.sendRedirect(url);
    * }
-   * </pre>
+   * }</pre>
    */
   public AuthorizationCodeRequestUrl newAuthorizationUrl() {
     AuthorizationCodeRequestUrl url =
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationCodeRequestUrl.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationCodeRequestUrl.java
@@ -31,14 +31,14 @@
  *
  * <p>Sample usage for a web application:
  *
- * <pre>
+ * <pre>{@code
  * public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
  * String url =
  * new AuthorizationCodeRequestUrl("https://server.example.com/authorize", "s6BhdRkqt3")
  * .setState("xyz").setRedirectUri("https://client.example.com/rd").build();
  * response.sendRedirect(url);
  * }
- * </pre>
+ * }</pre>
  *
  * <p>Implementation is not thread-safe.
  *
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationCodeResponseUrl.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationCodeResponseUrl.java
@@ -27,7 +27,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
  * StringBuffer fullUrlBuf = request.getRequestURL();
  * if (request.getQueryString() != null) {
@@ -42,7 +42,7 @@
  * // request access token using authResponse.getCode()...
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * <p>Implementation is not thread-safe.
  *
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationCodeTokenRequest.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationCodeTokenRequest.java
@@ -34,7 +34,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * static void requestAccessToken() throws IOException {
  * try {
  * TokenResponse response =
@@ -58,7 +58,7 @@
  * }
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * <p>Some OAuth 2.0 providers don't support {@link BasicAuthentication} but instead support {@link
  * ClientParametersAuthentication}. In the above sample code, simply replace the class name and it
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationRequestUrl.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/AuthorizationRequestUrl.java
@@ -27,14 +27,14 @@
  *
  * <p>Sample usage for a web application:
  *
- * <pre>
+ * <pre>{@code
  * public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
  * String url = new AuthorizationRequestUrl(
  * "https://server.example.com/authorize", "s6BhdRkqt3", Arrays.asList("code")).setState("xyz")
  * .setRedirectUri("https://client.example.com/rd").build();
  * response.sendRedirect(url);
  * }
- * </pre>
+ * }</pre>
  *
  * <p>Implementation is not thread-safe.
  *
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/BrowserClientRequestUrl.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/BrowserClientRequestUrl.java
@@ -27,14 +27,14 @@
  *
  * <p>Sample usage for a web application:
  *
- * <pre>
+ * <pre>{@code
  * public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
  * String url = new BrowserClientRequestUrl(
  * "https://server.example.com/authorize", "s6BhdRkqt3").setState("xyz")
  * .setRedirectUri("https://client.example.com/cb").build();
  * response.sendRedirect(url);
  * }
- * </pre>
+ * }</pre>
  *
  * <p>Implementation is not thread-safe.
  *
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/ClientCredentialsTokenRequest.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/ClientCredentialsTokenRequest.java
@@ -32,7 +32,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * static void requestAccessToken() throws IOException {
  * try {
  * TokenResponse response =
@@ -56,7 +56,7 @@
  * }
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * <p>Some OAuth 2.0 providers don't support {@link BasicAuthentication} but instead support {@link
  * ClientParametersAuthentication}. In the above sample code, simply replace the class name and it
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/ClientParametersAuthentication.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/ClientParametersAuthentication.java
@@ -33,7 +33,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * static void requestAccessToken() throws IOException {
  * try {
  * TokenResponse response = new AuthorizationCodeTokenRequest(new NetHttpTransport(),
@@ -56,7 +56,7 @@
  * }
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * <p>Implementation is immutable and thread-safe.
  *
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/Credential.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/Credential.java
@@ -43,7 +43,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * public static Credential createCredentialWithAccessTokenOnly(
  * HttpTransport transport, JsonFactory jsonFactory, TokenResponse tokenResponse) {
  * return new Credential(BearerToken.authorizationHeaderAccessMethod()).setFromTokenResponse(
@@ -61,7 +61,7 @@
  * .build()
  * .setFromTokenResponse(tokenResponse);
  * }
- * </pre>
+ * }</pre>
  *
  * <p>If you need to persist the access token in a data store, use {@link DataStoreFactory} and
  * {@link Builder#addRefreshListener(CredentialRefreshListener)} with {@link
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/DataStoreCredentialRefreshListener.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/DataStoreCredentialRefreshListener.java
@@ -28,14 +28,14 @@
  * <p>It needs to be added as a refresh listener using {@link
  * Credential.Builder#addRefreshListener}. Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * static void addDataStoreCredentialRefreshListener(
  * Credential.Builder credentialBuilder, String userId, DataStoreFactory dataStoreFactory)
  * throws IOException {
  * credentialBuilder.addRefreshListener(
  * new DataStoreCredentialRefreshListener(userId, dataStoreFactory));
  * }
- * </pre>
+ * }</pre>
  *
  * @since 1.6
  * @author Yaniv Inbar
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/PasswordTokenRequest.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/PasswordTokenRequest.java
@@ -35,7 +35,7 @@
  *
  * <p>Sample usage:
  *
- * <pre>
+ * <pre>{@code
  * static void requestAccessToken() throws IOException {
  * try {
  * TokenResponse response =
@@ -59,7 +59,7 @@
  * }
  * }
  * }
- * </pre>
+ * }</pre>
  *
  * <p>Some OAuth 2.0 providers don't support {@link BasicAuthentication} but instead support {@link
  * ClientParametersAuthentication}. In the above sample code, simply replace the class name and it
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/RefreshTokenRequest.java b/google-oauth-client/src/main/java/com/google/api/client/auth/oauth2/RefreshTokenRequest.java
diff --git a/google-oauth-client/src/main/java/com/google/api/client/auth/openidconnect/IdTokenResponse.java b/google-oauth-client/src/main/java/com/google/api/client/auth/openidconnect/IdTokenResponse.java

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@`
`43`	`43`	`*`
`44`	`44`	`* <p>Sample usage:`
`45`	`45`	`*`
`46`		`- * <pre>`
	`46`	`+ * <pre>{@code`
`47`	`47`	`* public class ServletCallbackSample extends AbstractAppEngineAuthorizationCodeCallbackServlet {`
`48`	`48`	`*`
`49`	`49`	`* @Override`
`@@ -77,7 +77,7 @@`
`77`	`77`	`* "https://server.example.com/authorize").setCredentialStore(new AppEngineCredentialStore())`
`78`	`78`	`* .build();`
`79`	`79`	`* }`
`80`		`- * </pre>`
	`80`	`+ * }</pre>`
`81`	`81`	`*`
`82`	`82`	`* @since 1.7`
`83`	`83`	`* @author Yaniv Inbar`
Original file line number	Diff line number	Diff line change
`@@ -84,14 +84,14 @@ public boolean load(String userId, Credential credential) {`
`84`	`84`	`*`
`85`	`85`	`* <p>Sample usage:`
`86`	`86`	`*`
`87`		`- * <pre>`
	`87`	`+ * <pre>{@code`
`88`	`88`	`* public static AppEngineDataStore migrate(AppEngineCredentialStore credentialStore)`
`89`	`89`	`* throws IOException {`
`90`	`90`	`* AppEngineDataStore dataStore = new AppEngineDataStore();`
`91`	`91`	`* credentialStore.migrateTo(dataStore);`
`92`	`92`	`* return dataStore;`
`93`	`93`	`* }`
`94`		`- * </pre>`
	`94`	`+ * }</pre>`
`95`	`95`	`*`
`96`	`96`	`* @param dataStoreFactory App Engine data store factory`
`97`	`97`	`* @since 1.16`
Original file line number	Diff line number	Diff line change
`@@ -174,14 +174,14 @@ private void save() throws IOException {`
`174`	`174`	`*`
`175`	`175`	`* <p>Sample usage:`
`176`	`176`	`*`
`177`		`- * <pre>`
	`177`	`+ * <pre>{@code`
`178`	`178`	`* public static FileDataStore migrate(FileCredentialStore credentialStore, File dataDirectory)`
`179`	`179`	`* throws IOException {`
`180`	`180`	`* FileDataStore dataStore = new FileDataStore(dataDirectory);`
`181`	`181`	`* credentialStore.migrateTo(dataStore);`
`182`	`182`	`* return dataStore;`
`183`	`183`	`* }`
`184`		`- * </pre>`
	`184`	`+ * }</pre>`
`185`	`185`	`*`
`186`	`186`	`* @param dataStoreFactory file data store factory`
`187`	`187`	`* @throws IOException`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`*`
`41`	`41`	`* <p>Sample usage:`
`42`	`42`	`*`
`43`		`- * <pre>`
	`43`	`+ * <pre>{@code`
`44`	`44`	`* public class ServletCallbackSample extends AbstractAuthorizationCodeCallbackServlet {`
`45`	`45`	`*`
`46`	`46`	`* @Override`
`@@ -81,7 +81,7 @@`
`81`	`81`	`* // return user ID`
`82`	`82`	`* }`
`83`	`83`	`* }`
`84`		`- * </pre>`
	`84`	`+ * }</pre>`
`85`	`85`	`*`
`86`	`86`	`* @since 1.7`
`87`	`87`	`* @author Yaniv Inbar`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@`
`49`	`49`	`*`
`50`	`50`	`* <p>Sample usage:`
`51`	`51`	`*`
`52`		`- * <pre>`
	`52`	`+ * <pre>{@code`
`53`	`53`	`* public class ServletSample extends AbstractAuthorizationCodeServlet {`
`54`	`54`	`*`
`55`	`55`	`* @Override`
`@@ -83,7 +83,7 @@`
`83`	`83`	`* // return user ID`
`84`	`84`	`* }`
`85`	`85`	`* }`
`86`		`- * </pre>`
	`86`	`+ * }</pre>`
`87`	`87`	`*`
`88`	`88`	`* @since 1.7`
`89`	`89`	`* @author Yaniv Inbar`