Uploaded image for project: 'Commons Math'
  1. Commons Math
  2. MATH-854

Fill the "throws" clause of all methods

Agile BoardRank to TopRank to BottomAttach filesAttach ScreenshotBulk Copy AttachmentsBulk Move AttachmentsVotersWatch issueWatchersCreate sub-taskConvert to sub-taskLinkCloneLabelsUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Task
    • Status: Resolved
    • Trivial
    • Resolution: Won't Fix
    • 3.0
    • 4.0
    • None
    • None

    Description

      In discussions that led to this thread, it was concluded that by having the "throws" clause of all methods to contain all exceptions possibly thrown (i.e. also the unchecked ones), it would be possible to ensure that the documentation is complete.

      This could be done by temporarily switching the base class "MathRuntimeException" (see MATH-853) to become a checked exception and generating the CheckStyle report which will detect the mismatch between the Javadoc and the "throws" clause. (Thanks to Luc for this trick.)

      Attachments

        Activity
          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            Unassigned Unassigned
            erans Gilles Sadowski
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Slack

                Issue deployment