Skip to content

[java][okhttp-gson] Fix warnings due to incorrect docstring #11815

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

Merged
wing328 merged 1 commit into from
Mar 7, 2022
Merged

[java][okhttp-gson] Fix warnings due to incorrect docstring #11815

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
36 changes: 18 additions & 18 deletions modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ public class ApiClient {
* <p>Setter for the field <code>dateFormat</code>.</p>
*
* @param dateFormat a {@link java.text.DateFormat} object
* @return a {@link org.openapitools.client.ApiClient} object
* @return a {@link {{invokerPackage}}.ApiClient} object
*/
public ApiClient setDateFormat(DateFormat dateFormat) {
this.json.setDateFormat(dateFormat);
Expand All @@ -395,7 +395,7 @@ public class ApiClient {
* <p>Set SqlDateFormat.</p>
*
* @param dateFormat a {@link java.text.DateFormat} object
* @return a {@link org.openapitools.client.ApiClient} object
* @return a {@link {{invokerPackage}}.ApiClient} object
*/
public ApiClient setSqlDateFormat(DateFormat dateFormat) {
this.json.setSqlDateFormat(dateFormat);
Expand All @@ -418,8 +418,8 @@ public class ApiClient {
/**
* <p>Set OffsetDateTimeFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link {{invokerPackage}}.ApiClient} object
*/
public ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat) {
this.json.setOffsetDateTimeFormat(dateFormat);
Expand All @@ -429,8 +429,8 @@ public class ApiClient {
/**
* <p>Set LocalDateFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link {{invokerPackage}}.ApiClient} object
*/
public ApiClient setLocalDateFormat(DateTimeFormatter dateFormat) {
this.json.setLocalDateFormat(dateFormat);
Expand All @@ -442,7 +442,7 @@ public class ApiClient {
* <p>Set LenientOnJson.</p>
*
* @param lenientOnJson a boolean
* @return a {@link org.openapitools.client.ApiClient} object
* @return a {@link {{invokerPackage}}.ApiClient} object
*/
public ApiClient setLenientOnJson(boolean lenientOnJson) {
this.json.setLenientOnJson(lenientOnJson);
Expand Down Expand Up @@ -1004,7 +1004,7 @@ public class ApiClient {
* @param response HTTP response
* @param returnType The type of the Java object
* @return The deserialized Java object
* @throws org.openapitools.client.ApiException If fail to deserialize response body, i.e. cannot read response body
* @throws {{invokerPackage}}.ApiException If fail to deserialize response body, i.e. cannot read response body
* or the Content-Type of the response is not supported.
*/
@SuppressWarnings("unchecked")
Expand Down Expand Up @@ -1065,7 +1065,7 @@ public class ApiClient {
* @param obj The Java object
* @param contentType The request Content-Type
* @return The serialized request body
* @throws org.openapitools.client.ApiException If fail to serialize the given object
* @throws {{invokerPackage}}.ApiException If fail to serialize the given object
*/
public RequestBody serialize(Object obj, String contentType) throws ApiException {
if (obj instanceof byte[]) {
Expand Down Expand Up @@ -1093,7 +1093,7 @@ public class ApiClient {
* Download file from the given response.
*
* @param response An instance of the Response object
* @throws org.openapitools.client.ApiException If fail to read file content from response and write to disk
* @throws {{invokerPackage}}.ApiException If fail to read file content from response and write to disk
* @return Downloaded file
*/
public File downloadFileFromResponse(Response response) throws ApiException {
Expand Down Expand Up @@ -1157,7 +1157,7 @@ public class ApiClient {
* @param <T> Type
* @param call An instance of the Call object
* @return ApiResponse&lt;T&gt;
* @throws org.openapitools.client.ApiException If fail to execute the call
* @throws {{invokerPackage}}.ApiException If fail to execute the call
*/
public <T> ApiResponse<T> execute(Call call) throws ApiException {
return execute(call, null);
Expand All @@ -1172,7 +1172,7 @@ public class ApiClient {
* @return ApiResponse object containing response status, headers and
* data, which is a Java object deserialized from response body and would be null
* when returnType is null.
* @throws org.openapitools.client.ApiException If fail to execute the call
* @throws {{invokerPackage}}.ApiException If fail to execute the call
*/
public <T> ApiResponse<T> execute(Call call, Type returnType) throws ApiException {
try {
Expand All @@ -1191,7 +1191,7 @@ public class ApiClient {
* @param call a {@link okhttp3.Call} object
* @param returnType a {@link java.lang.reflect.Type} object
* @return a {@link java.io.InputStream} object
* @throws org.openapitools.client.ApiException if any.
* @throws {{invokerPackage}}.ApiException if any.
*/
public InputStream executeStream(Call call, Type returnType) throws ApiException {
try {
Expand Down Expand Up @@ -1261,7 +1261,7 @@ public class ApiClient {
* @param response Response
* @param returnType Return type
* @return Type
* @throws org.openapitools.client.ApiException If the response has an unsuccessful status code or
* @throws {{invokerPackage}}.ApiException If the response has an unsuccessful status code or
* fail to deserialize the response body
*/
public <T> T handleResponse(Response response, Type returnType) throws ApiException {
Expand Down Expand Up @@ -1308,7 +1308,7 @@ public class ApiClient {
* @param authNames The authentications to apply
* @param callback Callback for upload/download progress
* @return The HTTP call
* @throws org.openapitools.client.ApiException If fail to serialize the request body object
* @throws {{invokerPackage}}.ApiException If fail to serialize the request body object
*/
public Call buildCall(String baseUrl, String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, String> cookieParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
Request request = buildRequest(baseUrl, path, method, queryParams, collectionQueryParams, body, headerParams, cookieParams, formParams, authNames, callback);
Expand All @@ -1331,7 +1331,7 @@ public class ApiClient {
* @param authNames The authentications to apply
* @param callback Callback for upload/download progress
* @return The HTTP request
* @throws org.openapitools.client.ApiException If fail to serialize the request body object
* @throws {{invokerPackage}}.ApiException If fail to serialize the request body object
*/
public Request buildRequest(String baseUrl, String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, String> cookieParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
// aggregate queryParams (non-collection) and collectionQueryParams into allQueryParams
Expand Down Expand Up @@ -1483,7 +1483,7 @@ public class ApiClient {
* @param payload HTTP request body
* @param method HTTP method
* @param uri URI
* @throws org.openapitools.client.ApiException If fails to update the parameters
* @throws {{invokerPackage}}.ApiException If fails to update the parameters
*/
public void updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String, String> headerParams,
Map<String, String> cookieParams, String payload, String method, URI uri) throws ApiException {
Expand Down Expand Up @@ -1737,7 +1737,7 @@ public class ApiClient {
*
* @param request The HTTP request object
* @return The string representation of the HTTP request body
* @throws org.openapitools.client.ApiException If fail to serialize the request body object into a string
* @throws {{invokerPackage}}.ApiException If fail to serialize the request body object into a string
*/
private String requestBodyToString(RequestBody requestBody) throws ApiException {
if (requestBody != null) {
Expand Down
4 changes: 2 additions & 2 deletions ...nt/others/java/okhttp-gson-streaming/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ public ApiClient setSqlDateFormat(DateFormat dateFormat) {
/**
* <p>Set OffsetDateTimeFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
*/
public ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat) {
Expand All @@ -307,7 +307,7 @@ public ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat) {
/**
* <p>Set LocalDateFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
*/
public ApiClient setLocalDateFormat(DateTimeFormatter dateFormat) {
Expand Down
4 changes: 2 additions & 2 deletions ...e/java/okhttp-gson-dynamicOperations/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ public ApiClient setSqlDateFormat(DateFormat dateFormat) {
/**
* <p>Set OffsetDateTimeFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
*/
public ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat) {
Expand All @@ -400,7 +400,7 @@ public ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat) {
/**
* <p>Set LocalDateFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
*/
public ApiClient setLocalDateFormat(DateTimeFormatter dateFormat) {
Expand Down
4 changes: 2 additions & 2 deletions ...ore/java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ public ApiClient setSqlDateFormat(DateFormat dateFormat) {
/**
* <p>Set OffsetDateTimeFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
*/
public ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat) {
Expand All @@ -389,7 +389,7 @@ public ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat) {
/**
* <p>Set LocalDateFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
*/
public ApiClient setLocalDateFormat(DateTimeFormatter dateFormat) {
Expand Down
4 changes: 2 additions & 2 deletions ...les/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ public ApiClient setSqlDateFormat(DateFormat dateFormat) {
/**
* <p>Set OffsetDateTimeFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
*/
public ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat) {
Expand All @@ -395,7 +395,7 @@ public ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat) {
/**
* <p>Set LocalDateFormat.</p>
*
* @param dateFormat a {@link org.threeten.bp.format.DateTimeFormatter} object
* @param dateFormat a {@link java.time.format.DateTimeFormatter} object
* @return a {@link org.openapitools.client.ApiClient} object
*/
public ApiClient setLocalDateFormat(DateTimeFormatter dateFormat) {
Expand Down