Skip to content
This repository was archived by the owner on Sep 10, 2019. It is now read-only.

Commit 5b68999

Browse files
committed
Fixing up the Groovydocs to remove <p/> in favor of <p>
1 parent 187d3c8 commit 5b68999

File tree

10 files changed

+27
-27
lines changed

10 files changed

+27
-27
lines changed

src/main/groovy/org/elasticsearch/groovy/action/ListenableActionFutureExtensions.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import static com.google.common.base.Preconditions.checkNotNull
2626
/**
2727
* {@code ListenableActionFutureExtensions} adds Groovy-friendly extensions to {@link ListenableActionFuture}s to
2828
* enable sometimes-simpler listener support.
29-
* <p />
29+
* <p>
3030
* Note: All of the listener methods behave like "add" methods. "add" was not used to avoid colliding with Java
3131
* variants to avoid unexpected issues ({@link Closure} is-a {@link Runnable}, which can cause confusion without explicit casting).
3232
* <pre>

src/main/groovy/org/elasticsearch/groovy/action/admin/cluster/repositories/put/PutRepositoryRequestExtensions.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import org.elasticsearch.client.ClusterAdminClient
2424

2525
/**
2626
* {@code PutRepositoryRequestExtensions} provides Groovy-friendly {@link PutRepositoryRequest} extensions.
27-
* <p />
27+
* <p>
2828
* Note: This extension intentionally does _not_ provide a {@code Closure} overload of
2929
* {@link PutRepositoryRequest#source(java.util.Map)} because it is interpreted the same as using
3030
* {@link org.codehaus.groovy.runtime.DefaultGroovyMethods#with} and a {@code Closure}.

src/main/groovy/org/elasticsearch/groovy/action/admin/cluster/snapshots/create/CreateSnapshotRequestExtensions.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import org.elasticsearch.client.ClusterAdminClient
2424

2525
/**
2626
* {@code CreateSnapshotRequestExtensions} provides Groovy-friendly {@link CreateSnapshotRequest} extensions.
27-
* <p />
27+
* <p>
2828
* Note: This extension intentionally does _not_ provide a {@code Closure} overload of
2929
* {@link CreateSnapshotRequest#source(java.util.Map)} because it is interpreted the same as using
3030
* {@link org.codehaus.groovy.runtime.DefaultGroovyMethods#with} and a {@code Closure}.

src/main/groovy/org/elasticsearch/groovy/action/admin/cluster/snapshots/restore/RestoreSnapshotRequestExtensions.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import org.elasticsearch.client.ClusterAdminClient
2424

2525
/**
2626
* {@code RestoreSnapshotRequestExtensions} provides Groovy-friendly {@link RestoreSnapshotRequest} extensions.
27-
* <p />
27+
* <p>
2828
* Note: This extension intentionally does _not_ provide a {@code Closure} overload of
2929
* {@link RestoreSnapshotRequest#source(java.util.Map)} because it is interpreted the same as using
3030
* {@link org.codehaus.groovy.runtime.DefaultGroovyMethods#with} and a {@code Closure}.

src/main/groovy/org/elasticsearch/groovy/action/search/SearchRequestExtensions.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class SearchRequestExtensions {
8888

8989
/**
9090
* Constructs a new search source builder with a raw search query.
91-
* <p />
91+
* <p>
9292
* Note: When building a new {@link SearchRequest}, using this method will overwrite other changes related to the
9393
* query.
9494
*

src/main/groovy/org/elasticsearch/groovy/client/ClientExtensions.groovy

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ class ClientExtensions extends AbstractClientExtensions {
121121

122122
/**
123123
* Index a document associated with a given index and type, then get the future result.
124-
* <p/>
124+
* <p>
125125
* The id is optional. If it is not provided, one will be generated automatically.
126126
* <pre>
127127
* IndexResponse response = client.index {
@@ -152,7 +152,7 @@ class ClientExtensions extends AbstractClientExtensions {
152152

153153
/**
154154
* Index a document associated with a given index and type, then get the future result.
155-
* <p/>
155+
* <p>
156156
* The id is optional. If it is not provided, one will be generated automatically.
157157
* <pre>
158158
* IndexResponse response = client.indexAsync {

src/main/groovy/org/elasticsearch/groovy/client/ClusterAdminClientExtensions.groovy

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ class ClusterAdminClientExtensions extends AbstractClientExtensions {
143143

144144
/**
145145
* Reroute the allocation of shards in the cluster.
146-
* <p />
146+
* <p>
147147
* Note: This is an Advanced API and care should be taken before performing related operations.
148148
*
149149
* @param self The {@code this} reference for the {@link ClusterAdminClient}.
@@ -157,7 +157,7 @@ class ClusterAdminClientExtensions extends AbstractClientExtensions {
157157

158158
/**
159159
* Reroute the allocation of shards in the cluster.
160-
* <p />
160+
* <p>
161161
* Note: This is an Advanced API and care should be taken before performing related operations.
162162
*
163163
* @param self The {@code this} reference for the {@link ClusterAdminClient}.
@@ -482,7 +482,7 @@ class ClusterAdminClientExtensions extends AbstractClientExtensions {
482482

483483
/**
484484
* Delete snapshots from a repository.
485-
* <p />
485+
* <p>
486486
* Note: Deleting a snapshot should only be done after creating newer snapshots, which are themselves backed up, in
487487
* order to avoid data loss.
488488
*
@@ -515,7 +515,7 @@ class ClusterAdminClientExtensions extends AbstractClientExtensions {
515515

516516
/**
517517
* Get a list of pending cluster tasks that are scheduled to be executed.
518-
* <p />
518+
* <p>
519519
* This includes operations that update the cluster state (e.g., a create index operation).
520520
*
521521
* @param self The {@code this} reference for the {@link ClusterAdminClient}.

src/main/groovy/org/elasticsearch/groovy/client/IndicesAdminClientExtensions.groovy

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
264264

265265
/**
266266
* Delete the specified indices.
267-
* <p />
267+
* <p>
268268
* Note: Manually supply the reserved index name of "_all" to delete all indices.
269269
*
270270
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
@@ -279,7 +279,7 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
279279

280280
/**
281281
* Delete the specified indices.
282-
* <p />
282+
* <p>
283283
* Note: Manually supply the reserved index name of "_all" to delete all indices.
284284
*
285285
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
@@ -349,7 +349,7 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
349349
/**
350350
* Explicitly flush the specified indices. A successful flush of an index guarantees that items in its transaction
351351
* log have been written to disk and starts a new transaction log.
352-
* <p />
352+
* <p>
353353
* Note: By default, Elasticsearch will perform flush operations automatically.
354354
*
355355
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
@@ -364,7 +364,7 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
364364
/**
365365
* Explicitly flush the specified indices. A successful flush of an index guarantees that items in its transaction
366366
* log have been written to disk and starts a new transaction log.
367-
* <p />
367+
* <p>
368368
* Note: By default, Elasticsearch will perform flush operations automatically.
369369
*
370370
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
@@ -378,10 +378,10 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
378378

379379
/**
380380
* Explicitly optimize the specified indices.
381-
* <p />
381+
* <p>
382382
* Optimizing an index will reduce the number of segments that the index contains, which will speed up future search
383383
* operations. Like other operations, Elasticsearch will automatically optimize indices in the background.
384-
* <p />
384+
* <p>
385385
* The optimal number of segments is <tt>1</tt>, but an active index will regularly have more than <tt>1</tt>. A
386386
* {@link IndicesAdminClient#close(CloseIndexRequest) closed} index can be safely optimized to <tt>1</tt> segment to
387387
* speed up future search operations.
@@ -397,10 +397,10 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
397397

398398
/**
399399
* Explicitly optimize the specified indices.
400-
* <p />
400+
* <p>
401401
* Optimizing an index will reduce the number of segments that the index contains, which will speed up future search
402402
* operations. Like other operations, Elasticsearch will automatically optimize indices in the background.
403-
* <p />
403+
* <p>
404404
* The optimal number of segments is <tt>1</tt>, but an active index will regularly have more than <tt>1</tt>. A
405405
* {@link IndicesAdminClient#close(CloseIndexRequest) closed} index can be safely optimized to <tt>1</tt> segment to
406406
* speed up future search operations.
@@ -588,7 +588,7 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
588588

589589
/**
590590
* Update the settings of one or more indices.
591-
* <p />
591+
* <p>
592592
* Note: Some settings can only be set at the creation of an index, such as the number of shards.
593593
*
594594
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
@@ -602,7 +602,7 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
602602

603603
/**
604604
* Update the settings of one or more indices.
605-
* <p />
605+
* <p>
606606
* Note: Some settings can only be set at the creation of an index, such as the number of shards.
607607
*
608608
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
@@ -644,7 +644,7 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
644644

645645
/**
646646
* Delete an index template.
647-
* <p />
647+
* <p>
648648
* Note: This will <em>not</em> unmap indices that have made use of this template.
649649
*
650650
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
@@ -658,7 +658,7 @@ class IndicesAdminClientExtensions extends AbstractClientExtensions {
658658

659659
/**
660660
* Delete an index template.
661-
* <p />
661+
* <p>
662662
* Note: This will <em>not</em> unmap indices that have made use of this template.
663663
*
664664
* @param self The {@code this} reference for the {@link IndicesAdminClient}.

src/main/groovy/org/elasticsearch/groovy/common/settings/SettingsBuilderExtensions.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import org.elasticsearch.common.settings.loader.JsonSettingsLoader
2424

2525
/**
2626
* {@code ImmutableSettingsBuilderExtensions} provide Groovy-friendly extensions to {@link ImmutableSettings.Builder}.
27-
* <p />
27+
* <p>
2828
* In particular, this adds the ability to specify settings in the form of a {@link Closure} in addition to existing
2929
* options.
3030
*/

src/main/groovy/org/elasticsearch/groovy/common/xcontent/XContentBuilderExtensions.groovy

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import org.elasticsearch.common.xcontent.XContentType
2929
/**
3030
* {@link XContentBuilderExtensions} adds Groovy-friendly extensions to {@link XContentBuilder} as well as directly to
3131
* {@link Closure}s.
32-
* <p />
32+
* <p>
3333
* In particular, this adds the ability to convert a {@link Closure} into a {@link Map} to a {@link XContentBuilder} to
3434
* enable effortless conversion:
3535
* <pre>
@@ -168,7 +168,7 @@ class XContentBuilderExtensions {
168168

169169
/**
170170
* Get the internal {@link XContentGenerator} of the {@link XContentBuilder}.
171-
* <p />
171+
* <p>
172172
* Note: This does <em>not</em> close the {@link XContentBuilder#generator()}.
173173
*
174174
* @param self The {@code this} reference for the {@link XContentBuilder}
@@ -182,7 +182,7 @@ class XContentBuilderExtensions {
182182

183183
/**
184184
* Get the internal {@link OutputStream} of the {@link XContentBuilder}.
185-
* <p />
185+
* <p>
186186
* Note: This does <em>not</em> close the {@link XContentBuilder#generator()}.
187187
*
188188
* @param self The {@code this} reference for the {@link XContentBuilder}

0 commit comments

Comments
 (0)