RFR: 8283269: Improve definition and use of jdk.javadoc.internal.doclets.toolkit.Content

[Pavel Rappo]

On Mon, 21 Mar 2022 18:29:59 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> I picked "inheritance" over "hierarchy" for consistency, because the relevant entities in HTML and CSS referred to "inheritance"; for example:
>> 
>>  * jdk/javadoc/internal/doclets/formats/html/resources/standard.properties:164
>>  * jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java:934
>> 
>> On the other hand, "hierarchy" was also a good choice because it could be used as a standalone noun, thus eliminating the need for the word "tree".
>> 
>> Thoughts?
>
> Yes, my criticism was about the use of the word "tree" in this case. While I agree that this is not the primary use you are trying to eliminate (i.e. HtmlTree-like trees) it  nevertheless is misleading to describe the superclasses of a class as forming a tree, since they form just a single branch of any tree.

Does your comment mean that we should similarly refine (later) the term "Inheritance Tree"?

To make sure we're on the same page, that method (whose doc comment we are talking about) is in charge of producing a small tree-like diagram you can see on the top of a class page. For example, for java.util.ArrayList that diagram looks like this:


java.lang.Object
    java.util.AbstractCollection<E>
        java.util.AbstractList<E>
            java.util.ArrayList<E>

-------------

PR: https://git.openjdk.java.net/jdk/pull/7843