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

Fill the "throws" clause of all methods

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Won't Fix
    • Affects Version/s: 3.0
    • Fix Version/s: 4.0
    • Labels:
      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

            People

            • Assignee:
              Unassigned
              Reporter:
              erans Gilles
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: