Skip to content

Commit 9d69407

Browse files
rubenhoenleGoopher Maijenburg
authored andcommitted
java-client: fix some javadoc comments (OpenAPITools#21932)
* java-client: fix some javadoc comments * update samples
1 parent 5af7edf commit 9d69407

File tree

16 files changed

+48
-48
lines changed
  • modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson
  • samples/client
    • echo_api/java
      • okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client
      • okhttp-gson/src/main/java/org/openapitools/client
    • others/java
      • okhttp-gson-oneOf-array/src/main/java/org/openapitools/client
      • okhttp-gson-oneOf/src/main/java/org/openapitools/client
      • okhttp-gson-streaming/src/main/java/org/openapitools/client
    • petstore/java
      • okhttp-gson-3.1-duplicated-operationid/src/main/java/org/openapitools/client
      • okhttp-gson-3.1/src/main/java/org/openapitools/client
      • okhttp-gson-awsv4signature/src/main/java/org/openapitools/client
      • okhttp-gson-dynamicOperations/src/main/java/org/openapitools/client
      • okhttp-gson-group-parameter/src/main/java/org/openapitools/client
      • okhttp-gson-nullable-required/src/main/java/org/openapitools/client
      • okhttp-gson-parcelableModel/src/main/java/org/openapitools/client
      • okhttp-gson-swagger1/src/main/java/org/openapitools/client
      • okhttp-gson-swagger2/src/main/java/org/openapitools/client
      • okhttp-gson/src/main/java/org/openapitools/client

16 files changed

+48
-48
lines changed

modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -289,8 +289,8 @@ public class ApiClient {
289289
/**
290290
* Set base path
291291
*
292-
* @param basePath Base path of the URL (e.g {{{basePath}}}
293-
* @return An instance of OkHttpClient
292+
* @param basePath Base path of the URL (e.g {{{basePath}}})
293+
* @return An instance of ApiClient
294294
*/
295295
public ApiClient setBasePath(String basePath) {
296296
this.basePath = basePath;
@@ -338,7 +338,7 @@ public class ApiClient {
338338
* Set HTTP client, which must never be null.
339339
*
340340
* @param newHttpClient An instance of OkHttpClient
341-
* @return Api Client
341+
* @return ApiClient
342342
* @throws java.lang.NullPointerException when newHttpClient is null
343343
*/
344344
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ public String getBasePath() {
232232
/**
233233
* Set base path
234234
*
235-
* @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2
236-
* @return An instance of OkHttpClient
235+
* @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2)
236+
* @return An instance of ApiClient
237237
*/
238238
public ApiClient setBasePath(String basePath) {
239239
this.basePath = basePath;
@@ -281,7 +281,7 @@ public OkHttpClient getHttpClient() {
281281
* Set HTTP client, which must never be null.
282282
*
283283
* @param newHttpClient An instance of OkHttpClient
284-
* @return Api Client
284+
* @return ApiClient
285285
* @throws java.lang.NullPointerException when newHttpClient is null
286286
*/
287287
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

samples/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ public String getBasePath() {
160160
/**
161161
* Set base path
162162
*
163-
* @param basePath Base path of the URL (e.g http://localhost:3000
164-
* @return An instance of OkHttpClient
163+
* @param basePath Base path of the URL (e.g http://localhost:3000)
164+
* @return An instance of ApiClient
165165
*/
166166
public ApiClient setBasePath(String basePath) {
167167
this.basePath = basePath;
@@ -209,7 +209,7 @@ public OkHttpClient getHttpClient() {
209209
* Set HTTP client, which must never be null.
210210
*
211211
* @param newHttpClient An instance of OkHttpClient
212-
* @return Api Client
212+
* @return ApiClient
213213
* @throws java.lang.NullPointerException when newHttpClient is null
214214
*/
215215
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

samples/client/others/java/okhttp-gson-oneOf-array/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ public String getBasePath() {
156156
/**
157157
* Set base path
158158
*
159-
* @param basePath Base path of the URL (e.g http://localhost
160-
* @return An instance of OkHttpClient
159+
* @param basePath Base path of the URL (e.g http://localhost)
160+
* @return An instance of ApiClient
161161
*/
162162
public ApiClient setBasePath(String basePath) {
163163
this.basePath = basePath;
@@ -205,7 +205,7 @@ public OkHttpClient getHttpClient() {
205205
* Set HTTP client, which must never be null.
206206
*
207207
* @param newHttpClient An instance of OkHttpClient
208-
* @return Api Client
208+
* @return ApiClient
209209
* @throws java.lang.NullPointerException when newHttpClient is null
210210
*/
211211
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

samples/client/others/java/okhttp-gson-oneOf/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ public String getBasePath() {
156156
/**
157157
* Set base path
158158
*
159-
* @param basePath Base path of the URL (e.g http://localhost
160-
* @return An instance of OkHttpClient
159+
* @param basePath Base path of the URL (e.g http://localhost)
160+
* @return An instance of ApiClient
161161
*/
162162
public ApiClient setBasePath(String basePath) {
163163
this.basePath = basePath;
@@ -205,7 +205,7 @@ public OkHttpClient getHttpClient() {
205205
* Set HTTP client, which must never be null.
206206
*
207207
* @param newHttpClient An instance of OkHttpClient
208-
* @return Api Client
208+
* @return ApiClient
209209
* @throws java.lang.NullPointerException when newHttpClient is null
210210
*/
211211
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

samples/client/others/java/okhttp-gson-streaming/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ public String getBasePath() {
156156
/**
157157
* Set base path
158158
*
159-
* @param basePath Base path of the URL (e.g http://localhost:8082
160-
* @return An instance of OkHttpClient
159+
* @param basePath Base path of the URL (e.g http://localhost:8082)
160+
* @return An instance of ApiClient
161161
*/
162162
public ApiClient setBasePath(String basePath) {
163163
this.basePath = basePath;
@@ -205,7 +205,7 @@ public OkHttpClient getHttpClient() {
205205
* Set HTTP client, which must never be null.
206206
*
207207
* @param newHttpClient An instance of OkHttpClient
208-
* @return Api Client
208+
* @return ApiClient
209209
* @throws java.lang.NullPointerException when newHttpClient is null
210210
*/
211211
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

samples/client/petstore/java/okhttp-gson-3.1-duplicated-operationid/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ public String getBasePath() {
232232
/**
233233
* Set base path
234234
*
235-
* @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2
236-
* @return An instance of OkHttpClient
235+
* @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2)
236+
* @return An instance of ApiClient
237237
*/
238238
public ApiClient setBasePath(String basePath) {
239239
this.basePath = basePath;
@@ -281,7 +281,7 @@ public OkHttpClient getHttpClient() {
281281
* Set HTTP client, which must never be null.
282282
*
283283
* @param newHttpClient An instance of OkHttpClient
284-
* @return Api Client
284+
* @return ApiClient
285285
* @throws java.lang.NullPointerException when newHttpClient is null
286286
*/
287287
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

samples/client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ public String getBasePath() {
232232
/**
233233
* Set base path
234234
*
235-
* @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2
236-
* @return An instance of OkHttpClient
235+
* @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2)
236+
* @return An instance of ApiClient
237237
*/
238238
public ApiClient setBasePath(String basePath) {
239239
this.basePath = basePath;
@@ -281,7 +281,7 @@ public OkHttpClient getHttpClient() {
281281
* Set HTTP client, which must never be null.
282282
*
283283
* @param newHttpClient An instance of OkHttpClient
284-
* @return Api Client
284+
* @return ApiClient
285285
* @throws java.lang.NullPointerException when newHttpClient is null
286286
*/
287287
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

samples/client/petstore/java/okhttp-gson-awsv4signature/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -236,8 +236,8 @@ public String getBasePath() {
236236
/**
237237
* Set base path
238238
*
239-
* @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2
240-
* @return An instance of OkHttpClient
239+
* @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2)
240+
* @return An instance of ApiClient
241241
*/
242242
public ApiClient setBasePath(String basePath) {
243243
this.basePath = basePath;
@@ -285,7 +285,7 @@ public OkHttpClient getHttpClient() {
285285
* Set HTTP client, which must never be null.
286286
*
287287
* @param newHttpClient An instance of OkHttpClient
288-
* @return Api Client
288+
* @return ApiClient
289289
* @throws java.lang.NullPointerException when newHttpClient is null
290290
*/
291291
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

samples/client/petstore/java/okhttp-gson-dynamicOperations/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -249,8 +249,8 @@ public String getBasePath() {
249249
/**
250250
* Set base path
251251
*
252-
* @param basePath Base path of the URL (e.g http://petstore.swagger.io:80/v2
253-
* @return An instance of OkHttpClient
252+
* @param basePath Base path of the URL (e.g http://petstore.swagger.io:80/v2)
253+
* @return An instance of ApiClient
254254
*/
255255
public ApiClient setBasePath(String basePath) {
256256
this.basePath = basePath;
@@ -298,7 +298,7 @@ public OkHttpClient getHttpClient() {
298298
* Set HTTP client, which must never be null.
299299
*
300300
* @param newHttpClient An instance of OkHttpClient
301-
* @return Api Client
301+
* @return ApiClient
302302
* @throws java.lang.NullPointerException when newHttpClient is null
303303
*/
304304
public ApiClient setHttpClient(OkHttpClient newHttpClient) {

0 commit comments

Comments
 (0)