commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Sébastien Brisard (JIRA) <>
Subject [jira] [Commented] (MATH-674) Too much documentation in ""?
Date Sat, 24 Sep 2011 04:17:26 GMT


Sébastien Brisard commented on MATH-674:

Got it. Sorry about that,

> Too much documentation in ""?
> --------------------------------------------------------
>                 Key: MATH-674
>                 URL:
>             Project: Commons Math
>          Issue Type: Improvement
>            Reporter: Gilles
>            Priority: Trivial
>              Labels: documentation
>             Fix For: 3.0
> I noticed that because they inherit the Javadoc for "UnivariateRealFunction", all functions
in package "o.a.c.m.analysis.function" have their "value" method contain a fairly large amount
of documentation that is related to a marginal issue (advice about why and when a user would
need to implement his own exceptions for his own functions) _that does not apply to the function
being documented_.
> It might be confusing to have that documentation appear there (i.e. in a place where
none of the functions are defined by the user). It should probably be moved elsewhere (user

This message is automatically generated by JIRA.
For more information on JIRA, see:


View raw message