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

Group "Throws:" entries by exception

    XMLWordPrintable

    Details

      Description

      Multiple @throws tags can be used in a documentation comment for the same or different exceptions.

      Consider merging entries that describe the same exception in resulting documentation. Not only could it improve readability, but also provide clearer model for writing around the inherited documentation when the overridden method provides multiple entries:

      Overrider:
          @throws exception-class "before" {@inheritDoc} "after"

      Overridden:
          @throws exception-class "first-entry"
          @throws exception-class "second-entry"
          ...

        Attachments

          Activity

            People

            Assignee:
            prappo Pavel Rappo
            Reporter:
            prappo Pavel Rappo
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: