LANG-1472: Javadoc clearly needs clarification

This commit is contained in:
Sebb 2019-08-13 14:19:40 +01:00
parent 1d037da2a8
commit add397b177
1 changed files with 3 additions and 2 deletions

View File

@ -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() {