Skip to content

Commit 75c6966

Browse files
swallezswallez
committed
Better Javadoc formatting
1 parent 9a0a089 commit 75c6966

File tree

325 files changed

+8398
-5630
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

325 files changed

+8398
-5630
lines changed

‎java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java

Lines changed: 298 additions & 150 deletions
Large diffs are not rendered by default.

‎java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java

Lines changed: 298 additions & 150 deletions
Large diffs are not rendered by default.

‎java-client/src/main/java/co/elastic/clients/elasticsearch/_global/BulkRequest.java

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ protected BulkRequest(Builder<TSource> builder) {
109109
}
110110

111111
/**
112-
* A comma-separated list of index names to search; use `_all` or empty string
113-
* to perform the operation on all indices
114-
*
112+
* A comma-separated list of index names to search; use <code>_all</code> or
113+
* empty string to perform the operation on all indices
114+
* <p>
115115
* API name: {@code index}
116116
*/
117117
@Nullable
@@ -122,7 +122,7 @@ public String index() {
122122
/**
123123
* A comma-separated list of document types to search; leave empty to perform
124124
* the operation on all types
125-
*
125+
* <p>
126126
* API name: {@code type}
127127
*/
128128
@Nullable
@@ -204,7 +204,7 @@ public Boolean requireAlias() {
204204

205205
/**
206206
* Request body.
207-
*
207+
* <p>
208208
* API name: {@code value}
209209
*/
210210
public List<JsonValue> value() {
@@ -269,9 +269,9 @@ public static class Builder<TSource> implements ObjectBuilder<BulkRequest<TSourc
269269
private JsonpSerializer<TSource> tSourceSerializer;
270270

271271
/**
272-
* A comma-separated list of index names to search; use `_all` or empty string
273-
* to perform the operation on all indices
274-
*
272+
* A comma-separated list of index names to search; use <code>_all</code> or
273+
* empty string to perform the operation on all indices
274+
* <p>
275275
* API name: {@code index}
276276
*/
277277
public Builder<TSource> index(@Nullable String value) {
@@ -282,7 +282,7 @@ public Builder<TSource> index(@Nullable String value) {
282282
/**
283283
* A comma-separated list of document types to search; leave empty to perform
284284
* the operation on all types
285-
*
285+
* <p>
286286
* API name: {@code type}
287287
*/
288288
public Builder<TSource> type(@Nullable String value) {
@@ -402,7 +402,7 @@ public Builder<TSource> requireAlias(@Nullable Boolean value) {
402402

403403
/**
404404
* Request body.
405-
*
405+
* <p>
406406
* API name: {@code value}
407407
*/
408408
public Builder<TSource> value(List<JsonValue> value) {
@@ -412,7 +412,7 @@ public Builder<TSource> value(List<JsonValue> value) {
412412

413413
/**
414414
* Request body.
415-
*
415+
* <p>
416416
* API name: {@code value}
417417
*/
418418
public Builder<TSource> value(JsonValue... value) {
@@ -434,7 +434,6 @@ public Builder<TSource> addValue(JsonValue value) {
434434
/**
435435
* Serializer for TSource. If not set, an attempt will be made to find a
436436
* serializer from the JSON context.
437-
*
438437
*/
439438
public Builder<TSource> tSourceSerializer(@Nullable JsonpSerializer<TSource> value) {
440439
this.tSourceSerializer = value;

‎java-client/src/main/java/co/elastic/clients/elasticsearch/_global/CreateRequest.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ public JsonValue waitForActiveShards() {
179179

180180
/**
181181
* Request body.
182-
*
182+
* <p>
183183
* API name: {@code value}
184184
*/
185185
public TDocument value() {
@@ -315,7 +315,7 @@ public Builder<TDocument> waitForActiveShards(@Nullable JsonValue value) {
315315

316316
/**
317317
* Request body.
318-
*
318+
* <p>
319319
* API name: {@code value}
320320
*/
321321
public Builder<TDocument> value(TDocument value) {
@@ -326,7 +326,6 @@ public Builder<TDocument> value(TDocument value) {
326326
/**
327327
* Serializer for TDocument. If not set, an attempt will be made to find a
328328
* serializer from the JSON context.
329-
*
330329
*/
331330
public Builder<TDocument> tDocumentSerializer(@Nullable JsonpSerializer<TDocument> value) {
332331
this.tDocumentSerializer = value;

‎java-client/src/main/java/co/elastic/clients/elasticsearch/_global/ExplainResponse.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,6 @@ public Builder<TDocument> get(Function<InlineGet.Builder<TDocument>, ObjectBuild
252252
/**
253253
* Serializer for TDocument. If not set, an attempt will be made to find a
254254
* serializer from the JSON context.
255-
*
256255
*/
257256
public Builder<TDocument> tDocumentSerializer(@Nullable JsonpSerializer<TDocument> value) {
258257
this.tDocumentSerializer = value;

‎java-client/src/main/java/co/elastic/clients/elasticsearch/_global/GetRequest.java

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ protected GetRequest(AbstractBuilder<?> builder) {
109109

110110
/**
111111
* Unique identifier of the document.
112-
*
112+
* <p>
113113
* API name: {@code id}
114114
*/
115115
public String id() {
@@ -118,7 +118,7 @@ public String id() {
118118

119119
/**
120120
* Name of the index that contains the document.
121-
*
121+
* <p>
122122
* API name: {@code index}
123123
*/
124124
public String index() {
@@ -136,7 +136,7 @@ public String type() {
136136
/**
137137
* Specifies the node or shard the operation should be performed on. Random by
138138
* default.
139-
*
139+
* <p>
140140
* API name: {@code preference}
141141
*/
142142
@Nullable
@@ -146,7 +146,7 @@ public String preference() {
146146

147147
/**
148148
* Boolean) If true, the request is real-time as opposed to near-real-time.
149-
*
149+
* <p>
150150
* API name: {@code realtime}
151151
*/
152152
@Nullable
@@ -157,7 +157,7 @@ public Boolean realtime() {
157157
/**
158158
* If true, Elasticsearch refreshes the affected shards to make this operation
159159
* visible to search. If false, do nothing with refreshes.
160-
*
160+
* <p>
161161
* API name: {@code refresh}
162162
*/
163163
@Nullable
@@ -167,7 +167,7 @@ public Boolean refresh() {
167167

168168
/**
169169
* Target the specified primary shard.
170-
*
170+
* <p>
171171
* API name: {@code routing}
172172
*/
173173
@Nullable
@@ -185,7 +185,7 @@ public Boolean sourceEnabled() {
185185

186186
/**
187187
* A comma-separated list of source fields to exclude in the response.
188-
*
188+
* <p>
189189
* API name: {@code _source_excludes}
190190
*/
191191
@Nullable
@@ -195,7 +195,7 @@ public List<String> sourceExcludes() {
195195

196196
/**
197197
* A comma-separated list of source fields to include in the response.
198-
*
198+
* <p>
199199
* API name: {@code _source_includes}
200200
*/
201201
@Nullable
@@ -214,7 +214,7 @@ public List<String> storedFields() {
214214
/**
215215
* Explicit version number for concurrency control. The specified version must
216216
* match the current version of the document for the request to succeed.
217-
*
217+
* <p>
218218
* API name: {@code version}
219219
*/
220220
@Nullable
@@ -224,7 +224,7 @@ public Number version() {
224224

225225
/**
226226
* Specific version type: internal, external, external_gte.
227-
*
227+
* <p>
228228
* API name: {@code version_type}
229229
*/
230230
@Nullable
@@ -235,7 +235,7 @@ public JsonValue versionType() {
235235
/**
236236
* True or false to return the _source field or not, or a list of fields to
237237
* return.
238-
*
238+
* <p>
239239
* API name: {@code _source}
240240
*/
241241
@Nullable
@@ -309,7 +309,7 @@ protected abstract static class AbstractBuilder<BuilderT extends AbstractBuilder
309309

310310
/**
311311
* Unique identifier of the document.
312-
*
312+
* <p>
313313
* API name: {@code id}
314314
*/
315315
public BuilderT id(String value) {
@@ -319,7 +319,7 @@ public BuilderT id(String value) {
319319

320320
/**
321321
* Name of the index that contains the document.
322-
*
322+
* <p>
323323
* API name: {@code index}
324324
*/
325325
public BuilderT index(String value) {
@@ -338,7 +338,7 @@ public BuilderT type(@Nullable String value) {
338338
/**
339339
* Specifies the node or shard the operation should be performed on. Random by
340340
* default.
341-
*
341+
* <p>
342342
* API name: {@code preference}
343343
*/
344344
public BuilderT preference(@Nullable String value) {
@@ -348,7 +348,7 @@ public BuilderT preference(@Nullable String value) {
348348

349349
/**
350350
* Boolean) If true, the request is real-time as opposed to near-real-time.
351-
*
351+
* <p>
352352
* API name: {@code realtime}
353353
*/
354354
public BuilderT realtime(@Nullable Boolean value) {
@@ -359,7 +359,7 @@ public BuilderT realtime(@Nullable Boolean value) {
359359
/**
360360
* If true, Elasticsearch refreshes the affected shards to make this operation
361361
* visible to search. If false, do nothing with refreshes.
362-
*
362+
* <p>
363363
* API name: {@code refresh}
364364
*/
365365
public BuilderT refresh(@Nullable Boolean value) {
@@ -369,7 +369,7 @@ public BuilderT refresh(@Nullable Boolean value) {
369369

370370
/**
371371
* Target the specified primary shard.
372-
*
372+
* <p>
373373
* API name: {@code routing}
374374
*/
375375
public BuilderT routing(@Nullable JsonValue value) {
@@ -387,7 +387,7 @@ public BuilderT sourceEnabled(@Nullable Boolean value) {
387387

388388
/**
389389
* A comma-separated list of source fields to exclude in the response.
390-
*
390+
* <p>
391391
* API name: {@code _source_excludes}
392392
*/
393393
public BuilderT sourceExcludes(@Nullable List<String> value) {
@@ -397,7 +397,7 @@ public BuilderT sourceExcludes(@Nullable List<String> value) {
397397

398398
/**
399399
* A comma-separated list of source fields to exclude in the response.
400-
*
400+
* <p>
401401
* API name: {@code _source_excludes}
402402
*/
403403
public BuilderT sourceExcludes(String... value) {
@@ -418,7 +418,7 @@ public BuilderT addSourceExcludes(String value) {
418418

419419
/**
420420
* A comma-separated list of source fields to include in the response.
421-
*
421+
* <p>
422422
* API name: {@code _source_includes}
423423
*/
424424
public BuilderT sourceIncludes(@Nullable List<String> value) {
@@ -428,7 +428,7 @@ public BuilderT sourceIncludes(@Nullable List<String> value) {
428428

429429
/**
430430
* A comma-separated list of source fields to include in the response.
431-
*
431+
* <p>
432432
* API name: {@code _source_includes}
433433
*/
434434
public BuilderT sourceIncludes(String... value) {
@@ -477,7 +477,7 @@ public BuilderT addStoredFields(String value) {
477477
/**
478478
* Explicit version number for concurrency control. The specified version must
479479
* match the current version of the document for the request to succeed.
480-
*
480+
* <p>
481481
* API name: {@code version}
482482
*/
483483
public BuilderT version(@Nullable Number value) {
@@ -487,7 +487,7 @@ public BuilderT version(@Nullable Number value) {
487487

488488
/**
489489
* Specific version type: internal, external, external_gte.
490-
*
490+
* <p>
491491
* API name: {@code version_type}
492492
*/
493493
public BuilderT versionType(@Nullable JsonValue value) {
@@ -498,7 +498,7 @@ public BuilderT versionType(@Nullable JsonValue value) {
498498
/**
499499
* True or false to return the _source field or not, or a list of fields to
500500
* return.
501-
*
501+
* <p>
502502
* API name: {@code _source}
503503
*/
504504
public BuilderT source(@Nullable JsonValue value) {

‎java-client/src/main/java/co/elastic/clients/elasticsearch/_global/GetResponse.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ public TDocument source() {
156156

157157
/**
158158
* deprecated since 7.0.0
159-
*
159+
* <p>
160160
* API name: {@code _type}
161161
*/
162162
@Nullable
@@ -357,7 +357,7 @@ public Builder<TDocument> source(@Nullable TDocument value) {
357357

358358
/**
359359
* deprecated since 7.0.0
360-
*
360+
* <p>
361361
* API name: {@code _type}
362362
*/
363363
public Builder<TDocument> type(@Nullable String value) {
@@ -376,7 +376,6 @@ public Builder<TDocument> version(@Nullable Number value) {
376376
/**
377377
* Serializer for TDocument. If not set, an attempt will be made to find a
378378
* serializer from the JSON context.
379-
*
380379
*/
381380
public Builder<TDocument> tDocumentSerializer(@Nullable JsonpSerializer<TDocument> value) {
382381
this.tDocumentSerializer = value;

‎java-client/src/main/java/co/elastic/clients/elasticsearch/_global/GetScriptRequest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public String id() {
6363

6464
/**
6565
* Specify timeout for connection to master
66-
*
66+
* <p>
6767
* API name: {@code master_timeout}
6868
*/
6969
@Nullable
@@ -92,7 +92,7 @@ public Builder id(String value) {
9292

9393
/**
9494
* Specify timeout for connection to master
95-
*
95+
* <p>
9696
* API name: {@code master_timeout}
9797
*/
9898
public Builder masterTimeout(@Nullable JsonValue value) {

0 commit comments

Comments
 (0)