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

Martin Buchholz martinrb at google.com
Wed Mar 21 21:13:23 UTC 2018


On Wed, Mar 21, 2018 at 2:03 PM, David Lloyd <david.lloyd at redhat.com> wrote:

> On Wed, Mar 21, 2018 at 3:39 PM, mandy chung <mandy.chung at oracle.com>
> 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?
>
> My impression is that it is generating its indexes and rendering on
> the fly (or at least in some opaque manner) directly from the sources.
> There does not seem to be any setting which governs what is produced
> or displayed; I think it is generally a feature (not a bug) that one
> can browse into dependency and JDK sources and get quick JavaDoc on
> any element, even non-public elements.
>

I agree with David - it's a feature of Intellij to make use of any
documentation available in the sources, including html links in private
javadoc.

Private method javadoc is less important than its public sibling.
Nevertheless, just like with any other documentation, it requires
maintenance.


More information about the core-libs-dev mailing list