You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@commons.apache.org by "Gilles (JIRA)" <ji...@apache.org> on 2016/05/06 20:30:13 UTC

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

     [ https://issues.apache.org/jira/browse/MATH-854?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gilles resolved MATH-854.
-------------------------
    Resolution: Won't Fix

Conclusion: Unchecked exceptions
* must be documented,
* must not appear in the signature ("throws" clause).


> 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: 4.0
>
>
> 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 was sent by Atlassian JIRA
(v6.3.4#6332)