Skip to content

Commit 631133e

Browse files
bednarbednar
authored
fix(docs): doclint for JDK 18 (#406)
1 parent fbc340d commit 631133e

62 files changed

Lines changed: 283 additions & 150 deletions

Some content is hidden

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

‎.circleci/config.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ commands:
4949
- run:
5050
name: "Running tests"
5151
command: |
52-
mvn -B -U clean install -Dmaven.javadoc.skip=true -Dmaven.dokka.skip=true -Dbuild.env=CI << parameters.junit-tests >>
52+
mvn -B -U clean install -Dbuild.env=CI << parameters.junit-tests >>
5353
- save_cache:
5454
name: Saving Maven Cache
5555
key: *cache-key

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## 6.6.0 [unreleased]
22

3+
### Documentation
4+
1. [#406](https://github.com/influxdata/influxdb-client-java/pull/406): Fix compatibility of the `doclint` between JDK 8 and JDK 18
5+
36
### Dependencies
47
Update dependencies:
58

‎client-osgi/src/main/java/com/influxdb/client/osgi/InfluxDBConnector.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@
5050
* <li>InfluxDB V2 client is created (by username and password) otherwise.</li>
5151
* </ol>
5252
*
53-
* <p>The following connector properties are added to InfluxDB client too: <tt>organization</tt>, <tt>bucket</tt>,
54-
* <tt>database</tt>, <tt>url</tt> and <tt>alias</tt>.</p>
53+
* <p>The following connector properties are added to InfluxDB client too: <code>organization</code>,
54+
* <code>bucket</code>, <code>database</code>, <code>url</code> and <code>alias</code>.</p>
5555
*/
5656
@Component(immediate = true, configurationPolicy = ConfigurationPolicy.REQUIRE, service = InfluxDBConnector.class)
5757
@Designate(ocd = InfluxDBConnector.Config.class)
@@ -77,7 +77,7 @@ public class InfluxDBConnector {
7777
String alias();
7878

7979
/**
80-
* InfluxDB URL, i.e. <tt>http://localhost:8086</tt>
80+
* InfluxDB URL, i.e. <code>http://localhost:8086</code>
8181
*/
8282
@AttributeDefinition(name = "InfluxDB URL")
8383
String url();

‎client-osgi/src/main/java/com/influxdb/client/osgi/LineProtocolWriter.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@
5353
* <ul>
5454
* <li><i>record</i> ({@link String}): value must be a single line protocol record</li>
5555
* <li><i>records</i> ({@link List}): value must be a list of line protocol records</li>
56-
* <li><i>precision</i> ({@link String}, optional): write precision, values: <tt>s</tt>, <tt>ms</tt>, <tt>us</tt>,
57-
* <tt>ns</tt>, default: <tt>ns</tt></li>
56+
* <li><i>precision</i> ({@link String}, optional): write precision, values: <code>s</code>, <code>ms</code>,
57+
* <code>us</code>, <code>ns</code>, default: <code>ns</code></li>
5858
* <li><i>organization</i> ({@link String}, optional): used to override InfluxDB organization of
5959
* {@link LineProtocolWriter} service (by event).</li>
6060
* <li><i>bucket</i> ({@link String}, optional): used to override InfluxDB bucket of
@@ -114,9 +114,9 @@ public class LineProtocolWriter implements EventHandler {
114114
String[] event_topics() default {DEFAULT_EVENT_TOPIC};
115115

116116
/**
117-
* OSGi target filter for InfluxDB connection, i.e. <tt>(alias=test)</tt>. The following properties are
118-
* copied from {@link InfluxDBConnector}: <tt>organization</tt>, <tt>bucket</tt>, <tt>database</tt>,
119-
* <tt>url</tt>, <tt>alias</tt>.
117+
* OSGi target filter for InfluxDB connection, i.e. <code>(alias=test)</code>. The following properties are
118+
* copied from {@link InfluxDBConnector}: <code>organization</code>, <code>bucket</code>, <code>database</code>,
119+
* <code>url</code>, <code>alias</code>.
120120
*/
121121
@AttributeDefinition(required = false, name = "InfluxDB client target",
122122
description = "OSGi target filter of InfluxDB client service")

‎client-osgi/src/main/java/com/influxdb/client/osgi/PointWriter.java‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,10 @@
7272
*
7373
* <p>One of <i>point</i> or <i>points</i> must be set.</p>
7474
*
75-
* <p>Measurement name is defined by OSGi event topic if {@link Map} type is used: measure name is fragment after the
76-
* last slash (<tt>/</tt>) character. For example: <b>weather</b> measure is written if event topic is
77-
* <tt>influxdb/point/weather</tt> (in this case OSGi event filter must be changed, i.e. <tt>influxdb/point/*</tt>).</p>
75+
* <p>Measurement name is defined by OSGi event topic if {@link Map} type is used: measure name is fragment after
76+
* the last slash (<code>/</code>) character. For example: <b>weather</b> measure is written
77+
* if event topic is <code>influxdb/point/weather</code> (in this case OSGi event filter must be changed,
78+
* i.e. <code>influxdb/point/*</code>).</p>
7879
*
7980
* <p>Structured data can be decorated with host name, host address or timestamp (by configuration).</p>
8081
*/
@@ -148,9 +149,9 @@ public class PointWriter implements EventHandler {
148149
String[] event_topics() default {DEFAULT_EVENT_TOPIC};
149150

150151
/**
151-
* OSGi target filter for InfluxDB connection, i.e. <tt>(alias=test)</tt>. The following properties are
152-
* copied from {@link InfluxDBConnector}: <tt>organization</tt>, <tt>bucket</tt>, <tt>database</tt>,
153-
* <tt>url</tt>, <tt>alias</tt>.
152+
* OSGi target filter for InfluxDB connection, i.e. <code>(alias=test)</code>. The following properties are
153+
* copied from {@link InfluxDBConnector}: <code>organization</code>, <code>bucket</code>, <code>database</code>,
154+
* <code>url</code>, <code>alias</code>.
154155
*/
155156
@AttributeDefinition(required = false, name = "InfluxDB client target",
156157
description = "OSGi target filter of InfluxDB client service")
@@ -179,7 +180,8 @@ public class PointWriter implements EventHandler {
179180
boolean timestamp_add() default false;
180181

181182
/**
182-
* Precision used if adding timestamp, values: <tt>s</tt>, <tt>ms</tt>, <tt>us</tt>, <tt>ns</tt>.
183+
* Precision used if adding timestamp, values: <code>s</code>, <code>ms</code>, <code>us</code>,
184+
* <code>ns</code>.
183185
*/
184186
@AttributeDefinition(required = false, name = "Precision",
185187
description = "Precision used if adding timestamp")

‎client/src/main/java/com/influxdb/client/InfluxQLQueryApi.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ public interface InfluxQLQueryApi {
6464
* Executes an InfluxQL query against the legacy endpoint.
6565
* The value extractor is called for each resulting column to convert the string value returned by query into a
6666
* custom type.
67-
*
68-
* <h3>Example</h3>
67+
* <p>
68+
* <b>Example:</b>
6969
* <pre>
7070
* InfluxQLQueryResult result = influxQLQueryApi.query(
7171
* new InfluxQLQuery("SELECT FIRST(\"free\") FROM \"influxql\"", DATABASE_NAME)

‎flux-dsl/src/main/java/com/influxdb/query/dsl/Expressions.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737

3838
/**
3939
* A container holding a list of {@link Expression}s.
40-
*
41-
* <h3>Example</h3>
40+
* <p>
41+
* <b>Example</b>
4242
* <pre>
4343
* VariableAssignment a = Flux.from("test1").asVariable("a");
4444
* VariableAssignment b = Flux.from("test2").asVariable("b");

0 commit comments

Comments
 (0)