Skip to content

Commit 422ab63

Browse files
committed
Javadoc
1 parent e9d7d35 commit 422ab63

File tree

5 files changed

+23
-24
lines changed

5 files changed

+23
-24
lines changed

src/main/java/org/apache/commons/lang3/ClassUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
public class ClassUtils {
5252

5353
/**
54-
* Inclusivity literals for {@link #hierarchy(Class, Interfaces)}.
54+
* Enumerates inclusivity literals for {@link #hierarchy(Class, Interfaces)}.
5555
*
5656
* @since 3.2
5757
*/

src/main/java/org/apache/commons/lang3/arch/Processor.java

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,21 @@
1717
package org.apache.commons.lang3.arch;
1818

1919
/**
20-
* The {@link Processor} represents a microprocessor and defines
21-
* some properties like architecture and type of the microprocessor.
20+
* Represents a microprocessor and defines some properties like architecture and type.
2221
*
2322
* @since 3.6
2423
*/
2524
public class Processor {
2625

2726
/**
28-
* The {@link Arch} enum defines the architecture of
29-
* a microprocessor. The architecture represents the bit value
30-
* of the microprocessor.
31-
* The following architectures are defined:
27+
* Enumerates the architecture of a microprocessor.
28+
* <p>
29+
* The architecture represents the bit value of the microprocessor. The following architectures are defined:
30+
* </p>
3231
* <ul>
33-
* <li>32-bit</li>
34-
* <li>64-bit</li>
35-
* <li>Unknown</li>
32+
* <li>32-bit</li>
33+
* <li>64-bit</li>
34+
* <li>Unknown</li>
3635
* </ul>
3736
*/
3837
public enum Arch {
@@ -72,15 +71,17 @@ public String getLabel() {
7271
}
7372

7473
/**
75-
* The {@link Type} enum defines types of a microprocessor.
74+
* Enumerates types of a microprocessor.
75+
* <p>
7676
* The following types are defined:
77+
* </p>
7778
* <ul>
78-
* <li>AArch64</li>
79-
* <li>x86</li>
80-
* <li>ia64</li>
81-
* <li>PPC</li>
82-
* <li>RISCV</li>
83-
* <li>Unknown</li>
79+
* <li>AArch64</li>
80+
* <li>x86</li>
81+
* <li>ia64</li>
82+
* <li>PPC</li>
83+
* <li>RISCV</li>
84+
* <li>Unknown</li>
8485
* </ul>
8586
*/
8687
public enum Type {

src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,8 @@
2929
public abstract class AbstractCircuitBreaker<T> implements CircuitBreaker<T> {
3030

3131
/**
32-
* An internal enumeration representing the different states of a circuit
33-
* breaker. This class also contains some logic for performing state
34-
* transitions. This is done to avoid complex if-conditions in the code of
35-
* {@link CircuitBreaker}.
32+
* Enumerates the different states of a circuit breaker. This class also contains some logic for performing state transitions. This is done to avoid complex
33+
* if-conditions in the code of {@link CircuitBreaker}.
3634
*/
3735
protected enum State {
3836

src/main/java/org/apache/commons/lang3/time/DateUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public void remove() {
114114
}
115115

116116
/**
117-
* Calendar modification types.
117+
* Enumerates calendar modification types.
118118
*/
119119
private enum ModifyType {
120120

src/main/java/org/apache/commons/lang3/time/StopWatch.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,14 +120,14 @@ public String toString() {
120120
}
121121

122122
/**
123-
* Enumeration type which indicates the split status of a StopWatch.
123+
* Enumerates the split states of a StopWatch.
124124
*/
125125
private enum SplitState {
126126
SPLIT, UNSPLIT
127127
}
128128

129129
/**
130-
* Enumeration type which indicates the status of a StopWatch.
130+
* Enumerates type status of a StopWatch.
131131
*/
132132
private enum State {
133133

0 commit comments

Comments
 (0)