This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
commit 8f3b627b5ad59ff6fe3d6a842ab31efc2bae4afb
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Nov 17 10:54:40 2024 -0500
[LANG-1511] SystemUtils is missing important documentation
---
.../java/org/apache/commons/lang3/SystemUtils.java | 21 +++++++++++++++++++--
1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java
b/src/main/java/org/apache/commons/lang3/SystemUtils.java
index 7103bd782..8f648a40c 100644
--- a/src/main/java/org/apache/commons/lang3/SystemUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java
@@ -2122,6 +2122,9 @@ public class SystemUtils {
/**
* Gets the current user directory as a {@link File}.
+ * <p>
+ * The result is based on the system property {@value
SystemProperties#USER_DIR}.
+ * </p>
*
* @return a directory
* @throws SecurityException if a security manager exists and its {@code
checkPropertyAccess} method doesn't allow access to the specified system
property.
@@ -2134,6 +2137,9 @@ public class SystemUtils {
/**
* Gets the current user home directory as a {@link File}.
+ * <p>
+ * The result is based on the system property {@value
SystemProperties#USER_HOME}.
+ * </p>
*
* @return a directory
* @throws SecurityException if a security manager exists and its {@code
checkPropertyAccess} method doesn't allow access to the specified system
property.
@@ -2146,6 +2152,9 @@ public class SystemUtils {
/**
* Gets the current user name.
+ * <p>
+ * The result is based on the system property {@value
SystemProperties#USER_NAME}.
+ * </p>
*
* @return a name
* @throws SecurityException if a security manager exists and its {@code
checkPropertyAccess} method doesn't allow access to the specified system
property.
@@ -2160,6 +2169,9 @@ public class SystemUtils {
/**
* Gets the user name.
+ * <p>
+ * The result is based on the system property {@value
SystemProperties#USER_NAME}.
+ * </p>
*
* @param defaultValue A default value.
* @return a name
@@ -2175,6 +2187,9 @@ public class SystemUtils {
/**
* Tests whether the {@link #JAVA_AWT_HEADLESS} value is {@code true}.
+ * <p>
+ * The result is based on the system property {@value
SystemProperties#JAVA_AWT_HEADLESS}.
+ * </p>
*
* @return {@code true} if {@code JAVA_AWT_HEADLESS} is {@code "true"},
{@code false} otherwise.
* @see #JAVA_AWT_HEADLESS
@@ -2187,6 +2202,9 @@ public class SystemUtils {
/**
* Tests whether the Java version at least the requested version.
+ * <p>
+ * The result is based on the system property saved in {@value
#JAVA_SPECIFICATION_VERSION}.
+ * </p>
*
* @param requiredVersion the required version, for example 1.31f
* @return {@code true} if the actual version is equal or greater than the
required version
@@ -2197,9 +2215,8 @@ public class SystemUtils {
/**
* Tests whether the Java version at most the requested version.
- *
* <p>
- * Example input:
+ * The result is based on the system property saved in {@value
#JAVA_SPECIFICATION_VERSION}.
* </p>
*
* @param requiredVersion the required version, for example 1.31f
