In this specific case, I think a "..., not null" caveat is sufficient. But in the general case, I think documenting interesting runtime exceptions in the javadoc is good practice. Does the CheckStyle config need tweaking?
On 8 February 2013 08:26, Benedikt Ritter <brit...@apache.org> wrote: > Hi Simo, > > > 2013/2/8 Simone Tripodi <simonetrip...@apache.org> > >> > How do you feel about this? Checkstyle complains about this, and I think >> it >> > is sufficient to tell users that an argument must not be null. >> >> sorry, which one? >> > > should have made that clearer :) > I removed the @throws NullpointerException from the JavaDoc because check > style complains about this (NPE is not declared in the method's signature). > I think it is enough to tell users that an argument must not be null. WDYT? > > Benedikt > > >> >> http://people.apache.org/~simonetripodi/ >> http://simonetripodi.livejournal.com/ >> http://twitter.com/simonetripodi >> http://www.99soft.org/ >> >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org >> For additional commands, e-mail: dev-h...@commons.apache.org >> >> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org For additional commands, e-mail: dev-h...@commons.apache.org
