[jira] [Created] (MATH-854) Fill the "throws" clause of all methods

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[jira] [Created] (MATH-854) Fill the "throws" clause of all methods

AD_LB (Jira)
Gilles created MATH-854:

             Summary: Fill the "throws" clause of all methods
                 Key: MATH-854
                 URL: https://issues.apache.org/jira/browse/MATH-854
             Project: Commons Math
          Issue Type: Task
    Affects Versions: 3.0
            Reporter: Gilles
            Priority: Trivial
             Fix For: 3.2

In discussions that led to this [thread|http://markmail.org/message/yu4lrnue54sncbek], 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.)

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira