JDK-8216205 : Java API documentation formatting error in System.getEnv()
  • Type: Bug
  • Component: core-libs
  • Sub-Component: java.lang
  • Affected Version: 11,12,13
  • Priority: P3
  • Status: Closed
  • Resolution: Fixed
  • Submitted: 2019-01-06
  • Updated: 2019-07-02
  • Resolved: 2019-01-07
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 11 JDK 13
11.0.5-oracleFixed 13 b03Fixed
Related Reports
Relates :  
Description
A DESCRIPTION OF THE PROBLEM :
Javadoc not formatted correctly:
"method is called with a {@link RuntimePermission}("getenv.*") permission"

@link is displayed instead of being processed.

REGRESSION : Last worked in version 10

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
Open Javadoc for System.getEnv()
Java 11
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#getenv()
Java 13 EA
https://download.java.net/java/early_access/jdk13/docs/api/java.base/java/lang/System.html#getenv()

EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
Text should be:
"method is called with a RuntimePermission("getenv.*") permission"
(with RuntimePermission linked)

As was the case until until Java 10
https://docs.oracle.com/javase/10/docs/api/java/lang/System.html#getenv()
ACTUAL -
Text is:
"method is called with a {@link RuntimePermission}("getenv.*") permission"

FREQUENCY : always



Comments
Fix Request (11u): Requesting backport for Oracle 11.0.5 parity. Doc only fix, no risk. Applies cleanly.
23-06-2019

The issue exists in all the latest versions. Likely introduced with fix JDK-8199420. Java 11 https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#getenv() Java 12 ea https://download.java.net/java/early_access/jdk12/docs/api/java.base/java/lang/System.html#getenv() Java 13 EA https://download.java.net/java/early_access/jdk13/docs/api/java.base/java/lang/System.html#getenv()
07-01-2019