JDK-8215039 : Add a mechanism to link to the definition of system properties
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Priority: P3
  • Status: New
  • Resolution: Unresolved
  • Submitted: 2018-12-08
  • Updated: 2023-08-30
Related Reports
Blocks :  
Description
It would be good to be able to link to the definition of a system property.

This may be an enhancement to the @see or {@link} mechanism.

An obvious/basic suggestion is   @see property:<name>

However, simple use of "name" would require a pass over all the doc comments to determine the location (defining type, and hence page) for every property. A secondary suggestion would be to require the reference to include the defining type, as in   @see property:<type>#<name>