Skip to content

Commit 3e2e8a5

Browse files
committed
Improved JavaDoc
1 parent 3ddb015 commit 3e2e8a5

4 files changed

Lines changed: 20 additions & 9 deletions

File tree

src/main/java/javax/measure/Quantity.java

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
* @see <a href="http://en.wikipedia.org/wiki/Quantity">Wikipedia: Quantity</a>
9292
* @see <a href="http://martinfowler.com/eaaDev/quantity.html">Martin Fowler -
9393
* Quantity</a>
94-
* @version 2.4, December 13, 2022
94+
* @version 2.5, May 20, 2023
9595
* @since 1.0
9696
*/
9797
public interface Quantity<Q extends Quantity<Q>> {
@@ -103,7 +103,15 @@ public interface Quantity<Q extends Quantity<Q>> {
103103
* @see <a href="https://en.wikipedia.org/wiki/Absolute_scale">Wikipedia: Absolute scale</a>
104104
*/
105105
public static enum Scale {
106-
ABSOLUTE, RELATIVE
106+
/**
107+
* Absolute scale
108+
* @see <a href="https://en.wikipedia.org/wiki/Absolute_scale">Wikipedia: Absolute scale</a>
109+
*/
110+
ABSOLUTE,
111+
/**
112+
* Relative scale
113+
*/
114+
RELATIVE
107115
}
108116

109117
/**

src/main/java/javax/measure/format/QuantityFormat.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
* @author <a href="mailto:werner@uom.technology">Werner Keil</a>
4747
* @author <a href="mailto:thodoris.bais@gmail.com">Thodoris Bais</a>
4848
*
49-
* @version 1.0, 3 July, 2020
49+
* @version 1.1, 20 May, 2023
5050
* @since 2.0
5151
*
5252
* @see Quantity
@@ -94,7 +94,7 @@ public interface QuantityFormat {
9494
* <p>
9595
* The parse must complete normally and parse the entire text. If the parse completes without reading the entire length of the text, an exception
9696
* is thrown. If any other problem occurs during parsing, an exception is thrown.
97-
* <p>
97+
* </p>
9898
*
9999
* @param csq
100100
* the {@code CharSequence} to parse.

src/main/java/javax/measure/format/UnitFormat.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@
4343
* <p>
4444
* Instances of this class are not required to be thread-safe. It is recommended to use separate format instances for each thread. If multiple threads
4545
* access a format concurrently, it must be synchronized externally.
46-
* <p>
46+
* </p>
4747
*
4848
* @author <a href="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a>
4949
* @author <a href="mailto:werner@uom.technology">Werner Keil</a>
5050
*
51-
* @version 2.1, June 16, 2021
51+
* @version 2.2, May 20, 2023
5252
* @since 1.0
5353
*
5454
* @see Unit
@@ -135,7 +135,7 @@ default boolean isLocaleSensitive() {
135135
* <p>
136136
* The parse must complete normally and parse the entire text. If the parse completes without reading the entire length of the text, an exception
137137
* is thrown. If any other problem occurs during parsing, an exception is thrown.
138-
* <p>
138+
* </p>
139139
*
140140
* @param csq
141141
* the {@code CharSequence} to parse.

src/main/java/javax/measure/spi/FormatService.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,17 @@
3838
* This interface represents the service to obtain instances of {@link UnitFormat} and {@link QuantityFormat}.
3939
*
4040
* @author <a href="mailto:werner@uom.technology">Werner Keil</a>
41-
* @version 2.2, June 6, 2021
41+
* @version 2.3, May 20, 2023
4242
* @since 2.0
4343
*/
4444
public interface FormatService {
4545

4646
/** The type of format, either a {@link UnitFormat} or {@link QuantityFormat} */
4747
public static enum FormatType {
48-
UNIT_FORMAT, QUANTITY_FORMAT
48+
/** Format of type {@link UnitFormat} */
49+
UNIT_FORMAT,
50+
/** Format of type {@link QuantityFormat} */
51+
QUANTITY_FORMAT
4952
}
5053

5154
/**

0 commit comments

Comments
 (0)