Skip to content

Commit

Permalink
Javadoc & format tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Jul 6, 2023
1 parent 5478116 commit 38f5501
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions src/main/java/org/apache/commons/lang3/ArchUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,11 @@
import org.apache.commons.lang3.stream.Streams;

/**
* A utility class for the {@code os.arch} System Property. The class defines methods for
* identifying the architecture of the current JVM.
* Provides methods for identifying the architecture of the current JVM based on the {@code "os.arch"} system property.
* <p>
* Important: The {@code os.arch} System Property returns the architecture used by the JVM
* not of the operating system.
* Important: The {@code "os.arch"} system property returns the architecture used by the JVM not of the operating system.
* </p>
*
* @since 3.6
*/
public class ArchUtils {
Expand Down Expand Up @@ -81,7 +80,7 @@ private static void init_PPC_64Bit() {
/**
* Adds the given {@link Processor} with the given key {@link String} to the map.
*
* @param key The key as {@link String}.
* @param key The key as {@link String}.
* @param processor The {@link Processor} to add.
* @throws IllegalStateException If the key already exists.
*/
Expand All @@ -95,7 +94,7 @@ private static void addProcessor(final String key, final Processor processor) {
/**
* Adds the given {@link Processor} with the given keys to the map.
*
* @param keys The keys.
* @param keys The keys.
* @param processor The {@link Processor} to add.
* @throws IllegalStateException If the key already exists.
*/
Expand All @@ -107,8 +106,7 @@ private static void addProcessors(final Processor processor, final String... key
* Gets a {@link Processor} object of the current JVM.
*
* <p>
* Important: The os.arch System Property returns the architecture used by the JVM
* not of the operating system.
* Important: The {@code "os.arch"} system property returns the architecture used by the JVM not of the operating system.
* </p>
*
* @return A {@link Processor} when supported, else {@code null}.
Expand All @@ -118,8 +116,8 @@ public static Processor getProcessor() {
}

/**
* Gets a {@link Processor} object the given value {@link String}. The {@link String} must be
* like a value returned by the {@code os.arch} System Property.
* Gets a {@link Processor} object the given value {@link String}. The {@link String} must be like a value returned by the {@code "os.arch"} system
* property.
*
* @param value A {@link String} like a value returned by the {@code os.arch} System Property.
* @return A {@link Processor} when it exists, else {@code null}.
Expand Down

0 comments on commit 38f5501

Please sign in to comment.