Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8295277

Expand {@inheritDoc} in @throws fully

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • P4
    • 20
    • 20
    • tools
    • None

    Description

      The solution provided for JDK-6509045 and JDK-8067757 becomes inadequate if documentation inheritance depth > 1 and {@inheritDoc} expands to multiple @throws tags on the higher levels of the inheritance hierarchy.

      The solution fails because the code that processes {@inheritDoc} in that case does not have necessary context to complete its job. While every @throws tag that a particular {@inheritDoc} expands to, translates to a separate entry in the "Throws:" section, by the time such an {@inheritDoc} is processed, the "Throws:" section is unavailable.

      One solution is to process {@inheritDoc} deeply and collectively in ThrowsTaglet#getAllBlockTagOutput. This hijacks the model of context-free processing, however, it does so just for one specific tag: @throws.

      Attachments

        Issue Links

          Activity

            People

              prappo Pavel Rappo
              prappo Pavel Rappo
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: