Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update javadocs for paginator style methods #4828

Merged
merged 1 commit into from
Jan 12, 2024
Merged

Update javadocs for paginator style methods #4828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion codegen/src/main/java/software/amazon/awssdk/codegen/docs/AsyncOperationDocProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ static class AsyncPaginated extends AsyncOperationDocProvider {
}

@Override
protected String appendToDescription() {
protected String getDescription() {
return paginationDocs.getDocsForAsyncOperation();
}

Expand Down
20 changes: 8 additions & 12 deletions codegen/src/main/java/software/amazon/awssdk/codegen/docs/OperationDocProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,19 +69,13 @@ abstract class OperationDocProvider {
String getDocs() {
DocumentationBuilder docBuilder = new DocumentationBuilder();

String description = StringUtils.isNotBlank(opModel.getDocumentation()) ?
opModel.getDocumentation() :
getDefaultServiceDocs();

String appendedDescription = appendToDescription();
String description = getDescription();

if (config.isConsumerBuilder()) {
appendedDescription += getConsumerBuilderDocs();
description += "<br/>" + getConsumerBuilderDocs();
}

docBuilder.description(StringUtils.isNotBlank(appendedDescription) ?
description + "<br/>" + appendedDescription :
description);
docBuilder.description(description);

applyParams(docBuilder);
applyReturns(docBuilder);
Expand All @@ -96,10 +90,12 @@ String getDocs() {
}

/**
* @return A string that will be appended to the standard description.
* @return The String description for the operation.
*/
protected String appendToDescription() {
return "";
protected String getDescription() {
return StringUtils.isNotBlank(opModel.getDocumentation()) ?
opModel.getDocumentation() :
getDefaultServiceDocs();
}

/**
Expand Down
2 changes: 1 addition & 1 deletion codegen/src/main/java/software/amazon/awssdk/codegen/docs/SyncOperationDocProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ static class SyncPaginated extends SyncOperationDocProvider {
}

@Override
protected String appendToDescription() {
protected String getDescription() {
return paginationDocs.getDocsForSyncOperation();
}

Expand Down
7 changes: 2 additions & 5 deletions ...esources/software/amazon/awssdk/codegen/poet/client/test-json-async-client-interface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,6 @@ default CompletableFuture<PaginatedOperationWithResultKeyResponse> paginatedOper
}

/**
* Some paginated operation with result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyRequest)}
Expand Down Expand Up @@ -835,7 +834,6 @@ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKey
}

/**
* Some paginated operation with result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyRequest)}
Expand Down Expand Up @@ -912,7 +910,6 @@ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKey
}

/**
* Some paginated operation with result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyRequest)}
Expand Down Expand Up @@ -966,6 +963,7 @@ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKey
* {@link #paginatedOperationWithResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyRequest)}
* operation.</b>
* </p>
* <br/>
* <p>
* This is a convenience which creates an instance of the {@link PaginatedOperationWithResultKeyRequest.Builder}
* avoiding the need to create one manually via {@link PaginatedOperationWithResultKeyRequest#builder()}
Expand Down Expand Up @@ -1055,7 +1053,6 @@ default CompletableFuture<PaginatedOperationWithoutResultKeyResponse> paginatedO
}

/**
* Some paginated operation without result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithoutResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyRequest)}
Expand Down Expand Up @@ -1132,7 +1129,6 @@ default PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutRes
}

/**
* Some paginated operation without result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithoutResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyRequest)}
Expand Down Expand Up @@ -1186,6 +1182,7 @@ default PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutRes
* {@link #paginatedOperationWithoutResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyRequest)}
* operation.</b>
* </p>
* <br/>
* <p>
* This is a convenience which creates an instance of the {@link PaginatedOperationWithoutResultKeyRequest.Builder}
* avoiding the need to create one manually via {@link PaginatedOperationWithoutResultKeyRequest#builder()}
Expand Down
7 changes: 2 additions & 5 deletions ...test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-interface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,6 @@ default PaginatedOperationWithResultKeyResponse paginatedOperationWithResultKey(
}

/**
* Some paginated operation with result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyRequest)}
Expand Down Expand Up @@ -601,7 +600,6 @@ default PaginatedOperationWithResultKeyIterable paginatedOperationWithResultKeyP
}

/**
* Some paginated operation with result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyRequest)}
Expand Down Expand Up @@ -678,7 +676,6 @@ default PaginatedOperationWithResultKeyIterable paginatedOperationWithResultKeyP
}

/**
* Some paginated operation with result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyRequest)}
Expand Down Expand Up @@ -734,6 +731,7 @@ default PaginatedOperationWithResultKeyIterable paginatedOperationWithResultKeyP
* {@link #paginatedOperationWithResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyRequest)}
* operation.</b>
* </p>
* <br/>
* <p>
* This is a convenience which creates an instance of the {@link PaginatedOperationWithResultKeyRequest.Builder}
* avoiding the need to create one manually via {@link PaginatedOperationWithResultKeyRequest#builder()}
Expand Down Expand Up @@ -815,7 +813,6 @@ default PaginatedOperationWithoutResultKeyResponse paginatedOperationWithoutResu
}

/**
* Some paginated operation without result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithoutResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyRequest)}
Expand Down Expand Up @@ -892,7 +889,6 @@ default PaginatedOperationWithoutResultKeyIterable paginatedOperationWithoutResu
}

/**
* Some paginated operation without result_key in paginators.json file<br/>
* <p>
* This is a variant of
* {@link #paginatedOperationWithoutResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyRequest)}
Expand Down Expand Up @@ -948,6 +944,7 @@ default PaginatedOperationWithoutResultKeyIterable paginatedOperationWithoutResu
* {@link #paginatedOperationWithoutResultKey(software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyRequest)}
* operation.</b>
* </p>
* <br/>
* <p>
* This is a convenience which creates an instance of the {@link PaginatedOperationWithoutResultKeyRequest.Builder}
* avoiding the need to create one manually via {@link PaginatedOperationWithoutResultKeyRequest#builder()}
Expand Down
Loading