Skip to content

Commit 1172310

Browse files
committed
Convert server javadoc to html5 (#30279)
This commit converts the remaining javadocs in :server using html4 to html5. This was mostly converting `tt` to `{@code}`.
1 parent 2ecac24 commit 1172310

File tree

145 files changed

+393
-409
lines changed

Some content is hidden

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

145 files changed

+393
-409
lines changed

buildSrc/src/main/groovy/org/elasticsearch/gradle/BuildPlugin.groovy

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -549,22 +549,6 @@ class BuildPlugin implements Plugin<Project> {
549549
javadoc.classpath = javadoc.getClasspath().filter { f ->
550550
return classes.contains(f) == false
551551
}
552-
/*
553-
* Force html5 on projects that support it to silence the warning
554-
* that `javadoc` will change its defaults in the future.
555-
*
556-
* But not all of our javadoc is actually valid html5. So we
557-
* have to become valid incrementally. We only set html5 on the
558-
* projects we have converted so that we still get the annoying
559-
* warning on the unconverted ones. That will give us an
560-
* incentive to convert them....
561-
*/
562-
List html4Projects = [
563-
':server',
564-
]
565-
if (false == html4Projects.contains(project.path)) {
566-
javadoc.options.addBooleanOption('html5', true)
567-
}
568552
}
569553
configureJavadocJar(project)
570554
}

buildSrc/src/main/groovy/org/elasticsearch/gradle/test/ClusterConfiguration.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class ClusterConfiguration {
6464
boolean debug = false
6565

6666
/**
67-
* Configuration of the setting <tt>discovery.zen.minimum_master_nodes</tt> on the nodes.
67+
* Configuration of the setting {@code discovery.zen.minimum_master_nodes} on the nodes.
6868
* In case of more than one node, this defaults to the number of nodes
6969
*/
7070
@Input

server/src/main/java/org/apache/lucene/queries/ExtendedCommonTermsQuery.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
/**
3030
* Extended version of {@link CommonTermsQuery} that allows to pass in a
31-
* <tt>minimumNumberShouldMatch</tt> specification that uses the actual num of high frequent terms
31+
* {@code minimumNumberShouldMatch} specification that uses the actual num of high frequent terms
3232
* to calculate the minimum matching terms.
3333
*/
3434
public class ExtendedCommonTermsQuery extends CommonTermsQuery {

server/src/main/java/org/elasticsearch/ElasticsearchException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -668,7 +668,7 @@ protected String getExceptionName() {
668668
}
669669

670670
/**
671-
* Returns a underscore case name for the given exception. This method strips <tt>Elasticsearch</tt> prefixes from exception names.
671+
* Returns a underscore case name for the given exception. This method strips {@code Elasticsearch} prefixes from exception names.
672672
*/
673673
public static String getExceptionName(Throwable ex) {
674674
String simpleName = ex.getClass().getSimpleName();

server/src/main/java/org/elasticsearch/action/ShardOperationFailedException.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@
3131
public interface ShardOperationFailedException extends Streamable, ToXContent {
3232

3333
/**
34-
* The index the operation failed on. Might return <tt>null</tt> if it can't be derived.
34+
* The index the operation failed on. Might return {@code null} if it can't be derived.
3535
*/
3636
String index();
3737

3838
/**
39-
* The index the operation failed on. Might return <tt>-1</tt> if it can't be derived.
39+
* The index the operation failed on. Might return {@code -1} if it can't be derived.
4040
*/
4141
int shardId();
4242

server/src/main/java/org/elasticsearch/action/ThreadingModel.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public byte id() {
3737
}
3838

3939
/**
40-
* <tt>true</tt> if the actual operation the action represents will be executed
40+
* {@code true} if the actual operation the action represents will be executed
4141
* on a different thread than the calling thread (assuming it will be executed
4242
* on the same node).
4343
*/
@@ -46,7 +46,7 @@ public boolean threadedOperation() {
4646
}
4747

4848
/**
49-
* <tt>true</tt> if the invocation of the action result listener will be executed
49+
* {@code true} if the invocation of the action result listener will be executed
5050
* on a different thread (than the calling thread or an "expensive" thread, like the
5151
* IO thread).
5252
*/

server/src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ public int getDelayedUnassignedShards() {
123123
}
124124

125125
/**
126-
* <tt>true</tt> if the waitForXXX has timeout out and did not match.
126+
* {@code true} if the waitForXXX has timeout out and did not match.
127127
*/
128128
public boolean isTimedOut() {
129129
return this.timedOut;

server/src/main/java/org/elasticsearch/action/admin/cluster/reroute/ClusterRerouteRequest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public ClusterRerouteRequest add(AllocationCommand... commands) {
5151
}
5252

5353
/**
54-
* Sets a dry run flag (defaults to <tt>false</tt>) allowing to run the commands without
54+
* Sets a dry run flag (defaults to {@code false}) allowing to run the commands without
5555
* actually applying them to the cluster state, and getting the resulting cluster state back.
5656
*/
5757
public ClusterRerouteRequest dryRun(boolean dryRun) {
@@ -78,7 +78,7 @@ public ClusterRerouteRequest explain(boolean explain) {
7878
}
7979

8080
/**
81-
* Sets the retry failed flag (defaults to <tt>false</tt>). If true, the
81+
* Sets the retry failed flag (defaults to {@code false}). If true, the
8282
* request will retry allocating shards that can't currently be allocated due to too many allocation failures.
8383
*/
8484
public ClusterRerouteRequest setRetryFailed(boolean retryFailed) {

server/src/main/java/org/elasticsearch/action/admin/cluster/reroute/ClusterRerouteRequestBuilder.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public ClusterRerouteRequestBuilder add(AllocationCommand... commands) {
4242
}
4343

4444
/**
45-
* Sets a dry run flag (defaults to <tt>false</tt>) allowing to run the commands without
45+
* Sets a dry run flag (defaults to {@code false}) allowing to run the commands without
4646
* actually applying them to the cluster state, and getting the resulting cluster state back.
4747
*/
4848
public ClusterRerouteRequestBuilder setDryRun(boolean dryRun) {
@@ -51,7 +51,7 @@ public ClusterRerouteRequestBuilder setDryRun(boolean dryRun) {
5151
}
5252

5353
/**
54-
* Sets the explain flag (defaults to <tt>false</tt>). If true, the
54+
* Sets the explain flag (defaults to {@code false}). If true, the
5555
* request will include an explanation in addition to the cluster state.
5656
*/
5757
public ClusterRerouteRequestBuilder setExplain(boolean explain) {
@@ -60,7 +60,7 @@ public ClusterRerouteRequestBuilder setExplain(boolean explain) {
6060
}
6161

6262
/**
63-
* Sets the retry failed flag (defaults to <tt>false</tt>). If true, the
63+
* Sets the retry failed flag (defaults to {@code false}). If true, the
6464
* request will retry allocating shards that can't currently be allocated due to too many allocation failures.
6565
*/
6666
public ClusterRerouteRequestBuilder setRetryFailed(boolean retryFailed) {

server/src/main/java/org/elasticsearch/action/admin/cluster/shards/ClusterSearchShardsRequest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ public ClusterSearchShardsRequest routing(String... routings) {
110110

111111
/**
112112
* Sets the preference to execute the search. Defaults to randomize across shards. Can be set to
113-
* <tt>_local</tt> to prefer local shards, <tt>_primary</tt> to execute only on primary shards, or
113+
* {@code _local} to prefer local shards, {@code _primary} to execute only on primary shards, or
114114
* a custom value, which guarantees that the same order will be used across different requests.
115115
*/
116116
public ClusterSearchShardsRequest preference(String preference) {

0 commit comments

Comments
 (0)