Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): doclint for JDK 18 #406

Merged
merged 4 commits into from
Sep 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ commands:
- run:
name: "Running tests"
command: |
mvn -B -U clean install -Dmaven.javadoc.skip=true -Dmaven.dokka.skip=true -Dbuild.env=CI << parameters.junit-tests >>
mvn -B -U clean install -Dbuild.env=CI << parameters.junit-tests >>
- save_cache:
name: Saving Maven Cache
key: *cache-key
Expand Down
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## 6.6.0 [unreleased]

### Documentation
1. [#406](https://github.com/influxdata/influxdb-client-java/pull/406): Fix compatibility of the `doclint` between JDK 8 and JDK 18

### Dependencies
Update dependencies:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@
* <li>InfluxDB V2 client is created (by username and password) otherwise.</li>
* </ol>
*
* <p>The following connector properties are added to InfluxDB client too: <tt>organization</tt>, <tt>bucket</tt>,
* <tt>database</tt>, <tt>url</tt> and <tt>alias</tt>.</p>
* <p>The following connector properties are added to InfluxDB client too: <code>organization</code>,
* <code>bucket</code>, <code>database</code>, <code>url</code> and <code>alias</code>.</p>
*/
@Component(immediate = true, configurationPolicy = ConfigurationPolicy.REQUIRE, service = InfluxDBConnector.class)
@Designate(ocd = InfluxDBConnector.Config.class)
Expand All @@ -77,7 +77,7 @@ public class InfluxDBConnector {
String alias();

/**
* InfluxDB URL, i.e. <tt>http://localhost:8086</tt>
* InfluxDB URL, i.e. <code>http://localhost:8086</code>
*/
@AttributeDefinition(name = "InfluxDB URL")
String url();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@
* <ul>
* <li><i>record</i> ({@link String}): value must be a single line protocol record</li>
* <li><i>records</i> ({@link List}): value must be a list of line protocol records</li>
* <li><i>precision</i> ({@link String}, optional): write precision, values: <tt>s</tt>, <tt>ms</tt>, <tt>us</tt>,
* <tt>ns</tt>, default: <tt>ns</tt></li>
* <li><i>precision</i> ({@link String}, optional): write precision, values: <code>s</code>, <code>ms</code>,
* <code>us</code>, <code>ns</code>, default: <code>ns</code></li>
* <li><i>organization</i> ({@link String}, optional): used to override InfluxDB organization of
* {@link LineProtocolWriter} service (by event).</li>
* <li><i>bucket</i> ({@link String}, optional): used to override InfluxDB bucket of
Expand Down Expand Up @@ -114,9 +114,9 @@ public class LineProtocolWriter implements EventHandler {
String[] event_topics() default {DEFAULT_EVENT_TOPIC};

/**
* OSGi target filter for InfluxDB connection, i.e. <tt>(alias=test)</tt>. The following properties are
* copied from {@link InfluxDBConnector}: <tt>organization</tt>, <tt>bucket</tt>, <tt>database</tt>,
* <tt>url</tt>, <tt>alias</tt>.
* OSGi target filter for InfluxDB connection, i.e. <code>(alias=test)</code>. The following properties are
* copied from {@link InfluxDBConnector}: <code>organization</code>, <code>bucket</code>, <code>database</code>,
* <code>url</code>, <code>alias</code>.
*/
@AttributeDefinition(required = false, name = "InfluxDB client target",
description = "OSGi target filter of InfluxDB client service")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,10 @@
*
* <p>One of <i>point</i> or <i>points</i> must be set.</p>
*
* <p>Measurement name is defined by OSGi event topic if {@link Map} type is used: measure name is fragment after the
* last slash (<tt>/</tt>) character. For example: <b>weather</b> measure is written if event topic is
* <tt>influxdb/point/weather</tt> (in this case OSGi event filter must be changed, i.e. <tt>influxdb/point/*</tt>).</p>
* <p>Measurement name is defined by OSGi event topic if {@link Map} type is used: measure name is fragment after
* the last slash (<code>/</code>) character. For example: <b>weather</b> measure is written
* if event topic is <code>influxdb/point/weather</code> (in this case OSGi event filter must be changed,
* i.e. <code>influxdb/point/*</code>).</p>
*
* <p>Structured data can be decorated with host name, host address or timestamp (by configuration).</p>
*/
Expand Down Expand Up @@ -148,9 +149,9 @@ public class PointWriter implements EventHandler {
String[] event_topics() default {DEFAULT_EVENT_TOPIC};

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

/**
* Precision used if adding timestamp, values: <tt>s</tt>, <tt>ms</tt>, <tt>us</tt>, <tt>ns</tt>.
* Precision used if adding timestamp, values: <code>s</code>, <code>ms</code>, <code>us</code>,
* <code>ns</code>.
*/
@AttributeDefinition(required = false, name = "Precision",
description = "Precision used if adding timestamp")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ public interface InfluxQLQueryApi {
* Executes an InfluxQL query against the legacy endpoint.
* The value extractor is called for each resulting column to convert the string value returned by query into a
* custom type.
*
* <h3>Example</h3>
* <p>
* <b>Example:</b>
* <pre>
* InfluxQLQueryResult result = influxQLQueryApi.query(
* new InfluxQLQuery("SELECT FIRST(\"free\") FROM \"influxql\"", DATABASE_NAME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@

/**
* A container holding a list of {@link Expression}s.
*
* <h3>Example</h3>
* <p>
* <b>Example</b>
* <pre>
* VariableAssignment a = Flux.from("test1").asVariable("a");
* VariableAssignment b = Flux.from("test2").asVariable("b");
Expand Down
Loading