Skip to content

Commit 90e531a

Browse files
millotpmillotp
authored
fix(java): add javadoc to all methods APIC-538 (#704)
1 parent 05fd13f commit 90e531a

File tree

7 files changed

+59
-24
lines changed

7 files changed

+59
-24
lines changed

‎templates/java/api_javadoc.mustache

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
* @throws AlgoliaRuntimeException If it fails to process the API call
2+
{{#isDeprecated}}
3+
* @deprecated
4+
{{/isDeprecated}}
5+
{{#externalDocs}}
6+
* @see <a href="{{url}}">{{{summary}}} Documentation</a> ({{{description}}})
7+
{{/externalDocs}}
8+
*/
9+
{{#isDeprecated}}
10+
@Deprecated
11+
{{/isDeprecated}}

‎templates/java/libraries/okhttp-gson/api.mustache

Lines changed: 41 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -134,17 +134,17 @@ public class {{classname}} extends ApiClient {
134134

135135
{{#operation}}
136136
/**
137-
* {{&notes}}{{#allParams}}
138-
* @param {{paramName}} {{&description}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#returnType}}
137+
* {{{notes}}}{{#allParams}}
138+
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#returnType}}
139139
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
140140
* @return {{.}}{{/returnType}}
141141
* @throws AlgoliaRuntimeException If fail to call the API, e.g. server error or cannot deserialize the response body
142142
{{#isDeprecated}}
143143
* @deprecated
144144
{{/isDeprecated}}
145145
{{#externalDocs}}
146-
* {{&description}}
147-
* @see <a href="{{url}}">{{&summary}} Documentation</a>
146+
* {{{description}}}
147+
* @see <a href="{{url}}">{{{summary}}} Documentation</a>
148148
{{/externalDocs}}
149149
*/
150150
{{#isDeprecated}}
@@ -155,19 +155,35 @@ public class {{classname}} extends ApiClient {
155155
}
156156

157157
{{! This case only sets `requestOptions` as optional }}
158+
/**
159+
* {{{notes}}}{{#allParams}}
160+
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#returnType}}
161+
* @return {{.}}{{/returnType}}
162+
{{> api_javadoc}}
158163
public {{#returnType}}{{{.}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{operationId}}({{#allParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}) throws AlgoliaRuntimeException {
159164
{{#returnType}}return {{/returnType}}this.{{operationId}}({{#allParams}}{{paramName}}, {{/allParams}}null);
160165
}
161166

162167
{{! This case sets `requiredParams` + `requestOptions` }}
163168
{{#optionalParams.0}}
169+
/**
170+
* {{{notes}}}{{#requiredParams}}
171+
* @param {{paramName}} {{{description}}} (required){{/requiredParams}}{{#returnType}}
172+
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
173+
* @return {{.}}{{/returnType}}
174+
{{> api_javadoc}}
164175
public {{#returnType}}{{{.}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{operationId}}({{#requiredParams}}{{{dataType}}} {{paramName}}, {{/requiredParams}}RequestOptions requestOptions) throws AlgoliaRuntimeException {
165176
{{#returnType}}return {{/returnType}}this.{{operationId}}({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, requestOptions);
166177
}
167178
{{/optionalParams.0}}
168179

169180
{{! This case only sets `requiredParams` }}
170181
{{#optionalParams.0}}
182+
/**
183+
* {{{notes}}}{{#requiredParams}}
184+
* @param {{paramName}} {{{description}}} (required){{/requiredParams}}{{#returnType}}
185+
* @return {{.}}{{/returnType}}
186+
{{> api_javadoc}}
171187
public {{#returnType}}{{{.}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{operationId}}({{#requiredParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}) throws AlgoliaRuntimeException {
172188
{{#returnType}}return {{/returnType}}this.{{operationId}}({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, null);
173189
}
@@ -178,19 +194,8 @@ public class {{classname}} extends ApiClient {
178194
* {{notes}}{{#allParams}}
179195
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
180196
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
181-
* @return The awaitable future
182-
* @throws AlgoliaRuntimeException If fail to process the API call, e.g. serializing the request body object
183-
{{#isDeprecated}}
184-
* @deprecated
185-
{{/isDeprecated}}
186-
{{#externalDocs}}
187-
* {{&description}}
188-
* @see <a href="{{url}}">{{&summary}} Documentation</a>
189-
{{/externalDocs}}
190-
*/
191-
{{#isDeprecated}}
192-
@Deprecated
193-
{{/isDeprecated}}
197+
* @return CompletableFuture<{{{returnType}}}> The awaitable future
198+
{{> api_javadoc}}
194199
public CompletableFuture<{{{returnType}}}> {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}RequestOptions requestOptions) throws AlgoliaRuntimeException {
195200
{{#allParams}}{{#required}}
196201
if ({{paramName}} == null) {
@@ -234,19 +239,38 @@ public class {{classname}} extends ApiClient {
234239
}
235240

236241
{{! This case only sets `requestOptions` as optional }}
242+
/**
243+
* (asynchronously)
244+
* {{notes}}{{#allParams}}
245+
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
246+
* @return CompletableFuture<{{{returnType}}}> The awaitable future
247+
{{> api_javadoc}}
237248
public CompletableFuture<{{{returnType}}}> {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}) throws AlgoliaRuntimeException {
238249
{{#returnType}}return {{/returnType}}this.{{operationId}}Async({{#allParams}}{{paramName}}, {{/allParams}}null);
239250
}
240251

241252
{{! This case sets `requiredParams` + `requestOptions` }}
242253
{{#optionalParams.0}}
254+
/**
255+
* (asynchronously)
256+
* {{notes}}{{#requiredParams}}
257+
* @param {{paramName}} {{{description}}} (required){{/requiredParams}}
258+
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
259+
* @return CompletableFuture<{{{returnType}}}> The awaitable future
260+
{{> api_javadoc}}
243261
public CompletableFuture<{{{returnType}}}> {{operationId}}Async({{#requiredParams}}{{{dataType}}} {{paramName}}, {{/requiredParams}}RequestOptions requestOptions) throws AlgoliaRuntimeException {
244262
{{#returnType}}return {{/returnType}}this.{{operationId}}Async({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, requestOptions);
245263
}
246264
{{/optionalParams.0}}
247265

248266
{{! This case only sets `requiredParams` }}
249267
{{#optionalParams.0}}
268+
/**
269+
* (asynchronously)
270+
* {{notes}}{{#requiredParams}}
271+
* @param {{paramName}} {{{description}}} (required){{/requiredParams}}
272+
* @return CompletableFuture<{{{returnType}}}> The awaitable future
273+
{{> api_javadoc}}
250274
public CompletableFuture<{{{returnType}}}> {{operationId}}Async({{#requiredParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}) throws AlgoliaRuntimeException {
251275
{{#returnType}}return {{/returnType}}this.{{operationId}}Async({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, null);
252276
}

‎templates/java/modelEnum.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import com.google.gson.stream.JsonWriter;
77
{{/gson}}
88

99
/**
10-
* {{&description}}{{^description}}Gets or Sets {{{name}}}{{/description}}
10+
* {{{description}}}{{^description}}Gets or Sets {{{name}}}{{/description}}
1111
*/
1212
{{#gson}}
1313
@JsonAdapter({{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.Adapter.class)

‎templates/java/modelInnerEnum.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* {{&description}}{{^description}}Gets or Sets {{{name}}}{{/description}}
2+
* {{{description}}}{{^description}}Gets or Sets {{{name}}}{{/description}}
33
*/
44
{{#gson}}
55
@JsonAdapter({{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}.Adapter.class)

‎templates/java/pojo.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* {{&description}}{{^description}}{{classname}}{{/description}}{{#isDeprecated}}
2+
* {{{description}}}{{^description}}{{classname}}{{/description}}{{#isDeprecated}}
33
* @deprecated{{/isDeprecated}}
44
*/{{#isDeprecated}}
55
@Deprecated{{/isDeprecated}}

‎templates/javascript/api/operation/jsdoc.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/**
22
{{#notes}}
3-
* {{&notes}}
3+
* {{{notes}}}
44
{{/notes}}
55
{{#summary}}
6-
* @summary {{&summary}}
6+
* @summary {{{summary}}}
77
{{/summary}}
88
{{#vendorExtensions}}
99
{{#x-create-wrapping-object}}

‎templates/php/ObjectSerializer.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class ObjectSerializer
5858
foreach ($data::openAPITypes() as $property => $openAPIType) {
5959
$getter = $data::getters()[$property];
6060
$value = $data->$getter();
61-
if ($value !== null && !in_array($openAPIType, [{{&primitives}}], true)) {
61+
if ($value !== null && !in_array($openAPIType, [{{{primitives}}}], true)) {
6262
$callable = [$openAPIType, 'getAllowableEnumValues'];
6363
if (is_callable($callable)) {
6464
/** array $callable */
@@ -305,7 +305,7 @@ class ObjectSerializer
305305
}
306306

307307
/** @psalm-suppress ParadoxicalCondition */
308-
if (in_array($class, [{{&primitives}}], true)) {
308+
if (in_array($class, [{{{primitives}}}], true)) {
309309
settype($data, $class);
310310
return $data;
311311
}

0 commit comments

Comments
 (0)