Javadoc & format tweaks

This commit is contained in:
Gary Gregory 2023-07-06 13:25:40 -04:00
parent 5478116bc1
commit 38f55010fb

View File

@ -23,12 +23,11 @@
import org.apache.commons.lang3.stream.Streams; import org.apache.commons.lang3.stream.Streams;
/** /**
* A utility class for the {@code os.arch} System Property. The class defines methods for * Provides methods for identifying the architecture of the current JVM based on the {@code "os.arch"} system property.
* identifying the architecture of the current JVM.
* <p> * <p>
* Important: The {@code os.arch} System Property returns the architecture used by the JVM * Important: The {@code "os.arch"} system property returns the architecture used by the JVM not of the operating system.
* not of the operating system.
* </p> * </p>
*
* @since 3.6 * @since 3.6
*/ */
public class ArchUtils { public class ArchUtils {
@ -81,7 +80,7 @@ private static void init_PPC_64Bit() {
/** /**
* Adds the given {@link Processor} with the given key {@link String} to the map. * 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. * @param processor The {@link Processor} to add.
* @throws IllegalStateException If the key already exists. * @throws IllegalStateException If the key already exists.
*/ */
@ -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. * 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. * @param processor The {@link Processor} to add.
* @throws IllegalStateException If the key already exists. * @throws IllegalStateException If the key already exists.
*/ */
@ -107,8 +106,7 @@ private static void addProcessors(final Processor processor, final String... key
* Gets a {@link Processor} object of the current JVM. * Gets a {@link Processor} object of the current JVM.
* *
* <p> * <p>
* Important: The os.arch System Property returns the architecture used by the JVM * Important: The {@code "os.arch"} system property returns the architecture used by the JVM not of the operating system.
* not of the operating system.
* </p> * </p>
* *
* @return A {@link Processor} when supported, else {@code null}. * @return A {@link Processor} when supported, else {@code null}.
@ -118,8 +116,8 @@ public static Processor getProcessor() {
} }
/** /**
* Gets a {@link Processor} object the given value {@link String}. The {@link String} must be * 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
* like a value returned by the {@code os.arch} System Property. * property.
* *
* @param value A {@link String} 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}. * @return A {@link Processor} when it exists, else {@code null}.