Skip to content

Commit ba52f6e

Browse files
committed
Fix javadoc
1 parent db92577 commit ba52f6e

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

src/main/java/io/jenkins/plugins/credentials/secretsmanager/factory/BaseAwsJsonCredentials.java

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,8 @@ public abstract class BaseAwsJsonCredentials extends BaseStandardCredentials {
3030
*
3131
* @param id The value for {@link #getId()}.
3232
* @param description The value for {@link #getDescription()}.
33-
* @param secretJsonSupplier Supplies the data that
34-
* {@link #getFieldFromSecretJson(String)} will
35-
* decode.
33+
* @param secretJsonSupplier Supplies the data that {@link #getSecretJson()}
34+
* will decode.
3635
*/
3736
protected BaseAwsJsonCredentials(String id, String description, Supplier<Secret> secretJsonSupplier) {
3837
super(id, description);
@@ -58,8 +57,10 @@ protected BaseAwsJsonCredentials(BaseAwsJsonCredentials toSnapshot) {
5857
/**
5958
* Reads the secret JSON and returns the field requested.
6059
*
61-
* @param fieldname The (top-level) field that we want (which must be a
62-
* {@link String}).
60+
* @param secretJson The {@link JSONObject} we're going to look in, which likely
61+
* came from {@link #getSecretJson()}.
62+
* @param fieldname The (top-level) field that we want (which must be a
63+
* {@link String}).
6364
* @return The contents of that JSON field.
6465
* @throws CredentialsUnavailableException if the JSON is missing the field, or
6566
* the field is not a {@link String}.
@@ -77,8 +78,10 @@ protected String getMandatoryField(@NonNull JSONObject secretJson, @NonNull Stri
7778
/**
7879
* Reads the secret JSON and returns the field requested.
7980
*
80-
* @param fieldname The (top-level) field that we want (which must be a
81-
* {@link String}).
81+
* @param secretJson The {@link JSONObject} we're going to look in, which likely
82+
* came from {@link #getSecretJson()}.
83+
* @param fieldname The (top-level) field that we want (which must be a
84+
* {@link String}).
8285
* @return The contents of that JSON field.
8386
*/
8487
protected String getOptionalField(@NonNull JSONObject secretJson, @NonNull String fieldname) {

0 commit comments

Comments
 (0)