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

Warn if {@inheritDoc} is ambiguous

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Unresolved
    • Icon: P4 P4
    • tbd
    • 21
    • tools
    • None

      It would be helpful if javadoc emitted a conditional warning for an ambiguous {@inheritDoc ...} (directed or otherwise).

      Such a warning could provide (i) the location of the ambiguous tag (ii) the automatic resolution that javadoc made: that is, the method where documentation was copied from, and (iii) the suggestion on how to eliminate ambiguity.

      {@inheritDoc ...} is ambiguous if any of these are true:
       * there are more than one resolution to it (i.e. more than one method to copy documentation from)
       * it resolves to another ambiguous {@inheritDoc ...}

      Ambiguity is resolved by automatic documentation algorithm.

      The purpose of this RFE is to provide a tool to wean authors off the magic of documentation inheritance, which is not always correct.

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

              Created:
              Updated: