Skip to content

Commit

Permalink
fixed javadoc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
albogdano committed Oct 28, 2020
1 parent f7003e8 commit e15ec0c
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 9 deletions.
3 changes: 2 additions & 1 deletion para-client/pom.xml
Expand Up @@ -69,7 +69,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<version>3.2.0</version>
<executions>
<execution>
<id>javadocs</id>
Expand All @@ -79,6 +79,7 @@
</execution>
</executions>
<configuration>
<source>1.8</source>
<stylesheetfile>../para-core/src/main/javadoc/stylesheet.css</stylesheetfile>
<show>public</show>
<aggregate>true</aggregate>
Expand Down
3 changes: 2 additions & 1 deletion para-core/pom.xml
Expand Up @@ -346,7 +346,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<version>3.2.0</version>
<executions>
<execution>
<id>javadocs</id>
Expand All @@ -356,6 +356,7 @@
</execution>
</executions>
<configuration>
<source>1.8</source>
<stylesheetfile>src/main/javadoc/stylesheet.css</stylesheetfile>
<show>public</show>
<aggregate>true</aggregate>
Expand Down
8 changes: 4 additions & 4 deletions para-core/src/main/java/com/erudika/para/utils/HumanTime.java
Expand Up @@ -33,27 +33,27 @@
/**
* HumanTime parses and formats time deltas for easier reading by humans. It can format time information without losing
* information but its main purpose is to generate more easily understood approximations.
* <h3>Using HumanTime</h3>
* <b>Using HumanTime</b>
* <p>
* Use HumanTime by creating an instance that contains the time delta ({@link HumanTime#HumanTime(long)}), create an
* empty instance through ({@link HumanTime#HumanTime()}) and set the delta using the {@link #y()}, {@link #d()},
* {@link #h()}, {@link #s()} and {@link #ms()} methods or parse a {@link CharSequence} representation
* ({@link #eval(CharSequence)}). Parsing ignores whitespace and is case insensitive.
* </p>
* <h3>HumanTime format</h3>
* <b>HumanTime format</b>
* <p>
* HumanTime will format time deltas in years ("y"), days ("d"), hours ("h"), minutes ("m"), seconds ("s") and
* milliseconds ("ms"), separated by a blank character. For approximate representations, the time delta will be round up
* or down if necessary.
* </p>
* <h3>HumanTime examples</h3>
* <b>HumanTime examples</b>
* <ul>
* <li>HumanTime.eval("1 d 1d 2m 3m").getExactly() = "2 d 5 m"</li>
* <li>HumanTime.eval("2m8d2h4m").getExactly() = "8 d 2 h 6 m"</li>
* <li>HumanTime.approximately("2 d 8 h 20 m 50 s") = "2 d 8 h"</li>
* <li>HumanTime.approximately("55m") = "1 h"</li>
* </ul>
* <h3>Implementation details</h3>
* <b>Implementation details</b>
* <ul>
* <li>The time delta can only be increased.</li>
* <li>Instances of this class are thread safe.</li>
Expand Down
3 changes: 2 additions & 1 deletion para-jar/pom.xml
Expand Up @@ -55,7 +55,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.1</version>
<version>3.2.0</version>
<executions>
<execution>
<id>javadocs</id>
Expand All @@ -65,6 +65,7 @@
</execution>
</executions>
<configuration>
<source>1.8</source>
<stylesheetfile>../para-core/src/main/javadoc/stylesheet.css</stylesheetfile>
<show>public</show>
<aggregate>true</aggregate>
Expand Down
3 changes: 2 additions & 1 deletion para-server/pom.xml
Expand Up @@ -399,7 +399,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<version>3.2.0</version>
<executions>
<execution>
<id>javadocs</id>
Expand All @@ -409,6 +409,7 @@
</execution>
</executions>
<configuration>
<source>1.8</source>
<stylesheetfile>../para-core/src/main/javadoc/stylesheet.css</stylesheetfile>
<show>public</show>
<aggregate>true</aggregate>
Expand Down
3 changes: 2 additions & 1 deletion pom.xml
Expand Up @@ -228,14 +228,15 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<version>3.2.0</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<source>1.8</source>
<stylesheetfile>para-core/src/main/javadoc/stylesheet.css</stylesheetfile>
<show>public</show>
<aggregate>true</aggregate>
Expand Down

0 comments on commit e15ec0c

Please sign in to comment.