Skip to content

Commit 39ece3c

Browse files
committed
HTML5ify Javadoc for xpack core (#30277)
xpack core contains a fork of `Cron` from quartz who's javadoc has a `<table>` with non-html5 compatible stuff. This html5ifies the table and switches the `:x-pack:plugin:core` project to building javadoc with HTML5.
1 parent 457ca64 commit 39ece3c

File tree

2 files changed

+42
-45
lines changed
  • buildSrc/src/main/groovy/org/elasticsearch/gradle
  • x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/scheduler

2 files changed

+42
-45
lines changed

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,6 @@ class BuildPlugin implements Plugin<Project> {
561561
*/
562562
List html4Projects = [
563563
':server',
564-
':x-pack:plugin:core',
565564
]
566565
if (false == html4Projects.contains(project.path)) {
567566
javadoc.options.addBooleanOption('html5', true)

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/scheduler/Cron.java

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
package org.elasticsearch.xpack.core.scheduler;
77

88
import org.elasticsearch.ElasticsearchParseException;
9-
import org.elasticsearch.common.xcontent.ToXContent;
109
import org.elasticsearch.common.xcontent.ToXContentFragment;
1110
import org.elasticsearch.common.xcontent.XContentBuilder;
1211
import org.joda.time.DateTimeZone;
@@ -29,8 +28,7 @@
2928

3029

3130
/**
32-
*
33-
* THIS CLASS IS A COPY OF
31+
* THIS CLASS IS A FORK OF
3432
* <a href="https://fisheye.terracotta.org/browse/Quartz/trunk/quartz-core/src/main/java/org/quartz/CronExpression.java?r=2426">
3533
* {@code CronExpression}</a>
3634
* FROM THE <a href="http://quartz-scheduler.org/">QUARTZ</a> PROJECT
@@ -44,63 +42,63 @@
4442
* Cron expressions are comprised of 6 required fields and one optional field
4543
* separated by white space. The fields respectively are described as follows:
4644
*
47-
* <table cellspacing="8">
45+
* <table style="border-collapse: separate; border-spacing: 8px;">
4846
* <caption>Fields in cron expressions</caption>
4947
* <tr>
50-
* <th align="left">Field Name</th>
51-
* <th align="left">&nbsp;</th>
52-
* <th align="left">Allowed Values</th>
53-
* <th align="left">&nbsp;</th>
54-
* <th align="left">Allowed Special Characters</th>
48+
* <th>Field Name</th>
49+
* <th>&nbsp;</th>
50+
* <th>Allowed Values</th>
51+
* <th>&nbsp;</th>
52+
* <th>Allowed Special Characters</th>
5553
* </tr>
5654
* <tr>
57-
* <td align="left"><code>Seconds</code></td>
58-
* <td align="left">&nbsp;</td>
59-
* <td align="left"><code>0-59</code></td>
60-
* <td align="left">&nbsp;</td>
61-
* <td align="left"><code>, - * /</code></td>
55+
* <td><code>Seconds</code></td>
56+
* <td>&nbsp;</td>
57+
* <td><code>0-59</code></td>
58+
* <td>&nbsp;</td>
59+
* <td><code>, - * /</code></td>
6260
* </tr>
6361
* <tr>
64-
* <td align="left"><code>Minutes</code></td>
65-
* <td align="left">&nbsp;</td>
66-
* <td align="left"><code>0-59</code></td>
67-
* <td align="left">&nbsp;</td>
68-
* <td align="left"><code>, - * /</code></td>
62+
* <td><code>Minutes</code></td>
63+
* <td>&nbsp;</td>
64+
* <td><code>0-59</code></td>
65+
* <td>&nbsp;</td>
66+
* <td><code>, - * /</code></td>
6967
* </tr>
7068
* <tr>
71-
* <td align="left"><code>Hours</code></td>
72-
* <td align="left">&nbsp;</td>
73-
* <td align="left"><code>0-23</code></td>
74-
* <td align="left">&nbsp;</td>
75-
* <td align="left"><code>, - * /</code></td>
69+
* <td><code>Hours</code></td>
70+
* <td>&nbsp;</td>
71+
* <td><code>0-23</code></td>
72+
* <td>&nbsp;</td>
73+
* <td><code>, - * /</code></td>
7674
* </tr>
7775
* <tr>
78-
* <td align="left"><code>Day-of-month</code></td>
79-
* <td align="left">&nbsp;</td>
80-
* <td align="left"><code>1-31</code></td>
81-
* <td align="left">&nbsp;</td>
82-
* <td align="left"><code>, - * ? / L W</code></td>
76+
* <td><code>Day-of-month</code></td>
77+
* <td>&nbsp;</td>
78+
* <td><code>1-31</code></td>
79+
* <td>&nbsp;</td>
80+
* <td><code>, - * ? / L W</code></td>
8381
* </tr>
8482
* <tr>
85-
* <td align="left"><code>Month</code></td>
86-
* <td align="left">&nbsp;</td>
87-
* <td align="left"><code>0-11 or JAN-DEC</code></td>
88-
* <td align="left">&nbsp;</td>
89-
* <td align="left"><code>, - * /</code></td>
83+
* <td><code>Month</code></td>
84+
* <td>&nbsp;</td>
85+
* <td><code>0-11 or JAN-DEC</code></td>
86+
* <td>&nbsp;</td>
87+
* <td><code>, - * /</code></td>
9088
* </tr>
9189
* <tr>
92-
* <td align="left"><code>Day-of-Week</code></td>
93-
* <td align="left">&nbsp;</td>
94-
* <td align="left"><code>1-7 or SUN-SAT</code></td>
95-
* <td align="left">&nbsp;</td>
96-
* <td align="left"><code>, - * ? / L #</code></td>
90+
* <td><code>Day-of-Week</code></td>
91+
* <td>&nbsp;</td>
92+
* <td><code>1-7 or SUN-SAT</code></td>
93+
* <td>&nbsp;</td>
94+
* <td><code>, - * ? / L #</code></td>
9795
* </tr>
9896
* <tr>
99-
* <td align="left"><code>Year (Optional)</code></td>
100-
* <td align="left">&nbsp;</td>
101-
* <td align="left"><code>empty, 1970-2199</code></td>
102-
* <td align="left">&nbsp;</td>
103-
* <td align="left"><code>, - * /</code></td>
97+
* <td><code>Year (Optional)</code></td>
98+
* <td>&nbsp;</td>
99+
* <td><code>empty, 1970-2199</code></td>
100+
* <td>&nbsp;</td>
101+
* <td><code>, - * /</code></td>
104102
* </tr>
105103
* </table>
106104
* <P>

0 commit comments

Comments
 (0)