[11] [PATCH] 9053056: Anchor name conflict in ClassLoader JavaDoc

Jonathan Gibbons jonathan.gibbons at oracle.com
Wed Mar 21 20:59:02 UTC 2018

On 03/21/2018 01:39 PM, mandy chung wrote:
> On 3/21/18 10:26 AM, David Lloyd wrote:
>> I see it with IntelliJ IDEA when I pop up "quick JavaDoc" on, say,
>> defineClass and then click on "binary name"; it's actually using the
>> sources, rather than generated JavaDoc.
> I don't object to do this renaming as I favor this more explicit id.  
> However you will hit the same issue if another class names an anchor 
> conflicts with its private member.   Can you configure IntelliJ to 
> generate public/protected elements to avoid this issue?
> Mandy


I think that maybe we should establish a convention such that 
user-defined anchors can never conflict with javadoc-generated anchors. 
Using an embedded "-" (as in this proposal) in user-defined anchors is a 
good start.

A secondary proposal would be to have doclint check for potential 
clashes. Even though we may use access filters to restrict the set of 
elements included in any documentation, it should never be good to 
facilitate clashes that may be caused by non-default options or 
non-default tools.

-- Jon

More information about the core-libs-dev mailing list