[commons-lang] branch master updated: LANG-1472: Javadoc clearly needs clarification

[se...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git


The following commit(s) were added to refs/heads/master by this push:
     new add397b  LANG-1472: Javadoc clearly needs clarification
add397b is described below

commit add397b17730873e1f47a597e9c28b67f6cbaa95
Author: Sebb <se...@apache.org>
AuthorDate: Tue Aug 13 14:19:40 2019 +0100

    LANG-1472: Javadoc clearly needs clarification
---
 src/main/java/org/apache/commons/lang3/SystemUtils.java | 5 +++--
 1 file changed, 3 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 f5085cf..0300e16 100644
--- a/src/main/java/org/apache/commons/lang3/SystemUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java
@@ -1544,13 +1544,14 @@ public class SystemUtils {
     }
 
     /**
-     * Gets the host name from an environment variable.
+     * Gets the host name from an environment variable
+     * (COMPUTERNAME on Windows, HOSTNAME elsewhere).
      *
      * <p>
      * If you want to know what the network stack says is the host name, you should use {@code InetAddress.getLocalHost().getHostName()}.
      * </p>
      *
-     * @return the host name.
+     * @return the host name. Will be {@code null} if the environment variable is not defined.
      * @since 3.6
      */
     public static String getHostName() {