Refactor code for inherited and derived documentation

XMLWordPrintable

    • Type: Enhancement
    • Resolution: Unresolved
    • Priority: P4
    • tbd
    • Affects Version/s: None
    • Component/s: tools
    • None

      The code for classical inheritance of JavaDoc comments is located mostly in the `toolkit.util.DocFinder` class, which is used by many `*Taglet` classes to find inherited documentation. The reverse lookup is located in the `getInheritedDocTreePath` method in `toolkit.util.CommentHelper`.

      Now with JDK-8324342 there is a new way to pass tags from enclosing to nested classes. This code is located in the `createWithDefaultForNested` method in `SimpleTaglet`. Additionally, this new form also needs to be handled when looking up the `DocTreePath` in `CommentHelper` (JDK-8332039).

      This leads to a confusing situation where lookup of doc comments is spread over many places. Ideally, the functionality described above should be refactored and brought together to a single class/abstraction.

            Assignee:
            Hannes Wallnoefer
            Reporter:
            Hannes Wallnoefer
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: