add missing javadocs and kdocs

Author: thisisabhash

aws-auth-cognito/src/main/java/com/amplifyframework/auth/cognito/options/AWSCognitoAuthWebUISignInOptions.java

@@ -36,14 +36,22 @@ public final class AWSCognitoAuthWebUISignInOptions extends AuthWebUISignInOptio
     private final String loginHint;
     private final List<AuthWebUIPrompt> prompt;
     private final String resource;
+
     /**
      * Advanced options for signing in via a hosted web ui.
      * @param scopes specify OAUTH scopes
      * @param idpIdentifier The IdentityProvider identifier if using multiple instances of same identity provider.
      * @param browserPackage Specify which browser package should be used for web sign in (e.g. "org.mozilla.firefox").
      *                       Defaults to the Chrome package if not specified.
      * @param preferPrivateSession specifying whether or not to launch web ui in an ephemeral CustomTab.
+     * @param nonce random value that can be added to the request, which is included in the ID token
+     *              that Amazon Cognito issues.
+     * @param language language displayed in user-interactive page
+     * @param loginHint username prompt passed to the authorization server
+     * @param prompt a list of OIDC parameters that controls authentication behavior for existing sessions.
+     * @param resource identifier of a resource that you want to bind to the access token in the `aud` claim.
      */
+    @SuppressWarnings("checkstyle:all")
     protected AWSCognitoAuthWebUISignInOptions(
             List<String> scopes,
             String idpIdentifier,
@@ -83,26 +91,53 @@ public String getBrowserPackage() {
         return browserPackage;
     }
 
+    /**
+     * Optional A random value that can be added to the request, which is included in the ID token
+     * that Amazon Cognito issues. To guard against replay attacks, your app can inspect the nonce claim in the ID
+     * token and compare it to the one you generated.
+     * @return the nonce value
+     */
     @Nullable
     public String getNonce() {
         return nonce;
     }
 
+    /** Optional The language displayed in user-interactive page.
+     * For more information, see Managed login localization
+     * https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html
+     * @return the language value
+     */
     @Nullable
     public String getLanguage() {
         return language;
     }
 
+    /** Optional A username prompt passed to the authorization server. You can collect a username, email
+     * address or phone number from your user and allow the destination provider to pre-populate the user's
+     * sign-in name.
+     * @return the login prompt displayed in the username field
+     */
     @Nullable
     public String getLoginHint() {
         return loginHint;
     }
 
+    /**
+     * Optional An OIDC parameter that controls authentication behavior for existing sessions.
+     * @return the prompt value
+     */
     @Nullable
     public List<AuthWebUIPrompt> getPrompt() {
         return prompt;
     }
 
+    /**
+     * Optional The identifier of a resource that you want to bind to the access token in the `aud`
+     * claim. When this parameter is included, Amazon Cognito validates that the value is a URL and
+     * sets the audience of the resulting access token to the requested resource. Values for this
+     * parameter must begin with "https://", "http://localhost" or a custom URL scheme like "myapp://".
+     * @return the resource value
+     */
     @Nullable
     public String getResource() {
         return resource;
@@ -158,7 +193,7 @@ public String toString() {
                 "scopes=" + getScopes() +
                 ", idpIdentifier=" + getIdpIdentifier() +
                 ", browserPackage=" + getBrowserPackage() +
-                ", preferPrivateSession=" + getPreferPrivateSession()  +
+                ", preferPrivateSession=" + getPreferPrivateSession() +
                 ", nonce=" + getNonce() +
                 ", language=" + getLanguage() +
                 ", loginHint=" + getLoginHint() +
@@ -206,33 +241,64 @@ public CognitoBuilder idpIdentifier(@NonNull String idpIdentifier) {
             return getThis();
         }
 
+        /**
+         * A random value that can be added to the request, which is included in the ID token
+         * that Amazon Cognito issues.
+         * @param nonce a random value to be added to the request
+         * @return the instance of the builder.
+         */
         @NonNull
         public CognitoBuilder nonce(@NonNull String nonce) {
             this.nonce = nonce;
             return getThis();
         }
 
+        /** The language displayed in user-interactive page.
+         * For more information, see Managed login localization
+         * https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html
+         * @param language language value
+         * @return the instance of the builder.
+         */
         @NonNull
         public CognitoBuilder language(@NonNull String language) {
             this.language = language;
             return getThis();
         }
 
+        /** A username prompt passed to the authorization server. You can collect a username, email
+         * address or phone number from your user and allow the destination provider to pre-populate the user's
+         * sign-in name.
+         * @param loginHint login prompt to pass to authorization server
+         * @return the instance of the builder.
+         */
         @NonNull
         public CognitoBuilder loginHint(@NonNull String loginHint) {
             this.loginHint = loginHint;
             return getThis();
         }
 
+        /**
+         * Optional An OIDC parameter that controls authentication behavior for existing sessions.
+         * @param prompt list of AuthWebUIPrompt values
+         * @return the instance of the builder.
+         */
         @NonNull
         public CognitoBuilder prompt(AuthWebUIPrompt... prompt) {
             this.prompt = new ArrayList<>();
-            for (AuthWebUIPrompt value: prompt) {
+            for (AuthWebUIPrompt value : prompt) {
                 this.prompt.add(value);
             }
             return getThis();
         }
 
+        /**
+         * Optional The identifier of a resource that you want to bind to the access token in the `aud`
+         * claim. When this parameter is included, Amazon Cognito validates that the value is a URL and
+         * sets the audience of the resulting access token to the requested resource. Values for this
+         * parameter must begin with "https://", "http://localhost" or a custom URL scheme like "myapp://".
+         * @param resource resource value
+         * @return the instance of the builder.
+         */
         @NonNull
         public CognitoBuilder resource(@NonNull String resource) {
             this.resource = resource;

aws-auth-cognito/src/main/java/com/amplifyframework/auth/cognito/options/AuthWebUIPrompt.kt

@@ -1,11 +1,39 @@
 package com.amplifyframework.auth.cognito.options
 
+/**
+ * An OIDC parameter that controls authentication behavior for existing sessions.
+ */
 public enum class AuthWebUIPrompt(val value: String) {
+    /**
+     * Amazon Cognito silently continues authentication for users who have a valid authenticated session.
+     * With this prompt, users can silently authenticate between different app clients in your user pool.
+     * If the user is not already authenticated, the authorization server returns a login_required error.
+     */
     NONE(value = "none"),
 
+    /**
+     * Amazon Cognito requires users to re-authenticate even if they have an existing session. Send this
+     * value when you want to verify the user's identity again. Authenticated users who have an existing
+     * session can return to sign-in without invalidating that session. When a user who has an existing
+     * session signs in again, Amazon Cognito assigns them a new session cookie. This parameter can also
+     * be forwarded to your IdPs. IdPs that accept this parameter also request a new authentication
+     * attempt from the user.
+     */
     LOGIN(value = "login"),
 
+    /**
+     * This value has no effect on local sign-in and must be submitted in requests that redirect to IdPs.
+     * When included in your authorization request, this parameter adds prompt=select_account to the URL
+     * path for the IdP redirect destination. When IdPs support this parameter, they request that users
+     * select the account that they want to log in with.
+     */
     SELECT_ACCOUNT(value = "select_account"),
 
+    /**
+     * This value has no effect on local sign-in and must be submitted in requests that redirect to IdPs.
+     * When included in your authorization request, this parameter adds prompt=consent to the URL path for
+     * the IdP redirect destination. When IdPs support this parameter, they request user consent before
+     * they redirect back to your user pool.
+     */
     CONSENT(value = "consent")
 }

aws-auth-cognito/src/test/java/com/amplifyframework/auth/cognito/options/APIOptionsContractTest.java

@@ -128,6 +128,9 @@ public void testCognitoOptions() {
                 .getDeveloperProvidedIdentityId());
     }
 
+    /**
+     * Test Java CognitoAuthWebUIOptions OIDC parameters builder methods.
+     */
     @Test
     public void testCognitoAuthWebUISignInOIDCParameters() {
         List<AuthWebUIPrompt> prompt = Arrays.asList(AuthWebUIPrompt.LOGIN, AuthWebUIPrompt.CONSENT);