[LANG-1511] SystemUtils is missing important documentation

garydgregory · garydgregory · commit f43d3313f724 · 2024-11-17T10:56:59.000-05:00
diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java b/src/main/java/org/apache/commons/lang3/SystemUtils.java
@@ -2308,7 +2308,8 @@ static boolean isOsVersionMatch(final String osVersion, final String osVersionPr
     }
 
     /**
-     * SystemUtils instances should NOT be constructed in standard programming. Instead, the class should be used as {@code SystemUtils.FILE_SEPARATOR}.
+     * SystemUtils instances shouldn't be constructed in standard programming. Instead, elements should be accessed directly, for example
+     * {@code SystemUtils.FILE_SEPARATOR}.
      *
      * <p>
      * This constructor is public to permit tools that require a JavaBean instance to operate.

Original file line number	Diff line number	Diff line change
`@@ -2308,7 +2308,8 @@ static boolean isOsVersionMatch(final String osVersion, final String osVersionPr`
`2308`	`2308`	`}`
`2309`	`2309`
`2310`	`2310`	`/**`
`2311`		`- * SystemUtils instances should NOT be constructed in standard programming. Instead, the class should be used as {@code SystemUtils.FILE_SEPARATOR}.`
	`2311`	`+ * SystemUtils instances shouldn't be constructed in standard programming. Instead, elements should be accessed directly, for example`
	`2312`	`+ * {@code SystemUtils.FILE_SEPARATOR}.`
`2312`	`2313`	`*`
`2313`	`2314`	`* <p>`
`2314`	`2315`	`* This constructor is public to permit tools that require a JavaBean instance to operate.`