commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Gregory <garydgreg...@gmail.com>
Subject Re: [codec] javadoc style
Date Thu, 30 Aug 2012 20:21:43 GMT
On Thu, Aug 30, 2012 at 2:57 PM, Thomas Neidhart
<thomas.neidhart@gmail.com>wrote:

> Hi,
>
> there are quite some differences on the javadoc style in the source
> files, e.g. the number of spaces before a @param description, whether
> there is an empty line between @param, @return and @throws.
>

I like the default Eclipse formatting style:

     /**
     * ...
     *
     * @param arg1
     *            blah blah blah blah
     * @throws SomeException
     *            blah blah
     */


> Any thoughts on that? I am willing to clean up but do not want to impose
> any personal preference.
>

I'm not sure it is worth fixing, but if it bothers you, feel free :)


>
> btw. how do we treat the cases in the language.bm package wrt System.err
> statements? For now I marked them as comment and put a FIXME.
> The are there in case an unexpected input is read from a resource file
> at runtime.
>

I would probably throw an IllegalArgumentException. You can code that and
see if the tests all pass.

Gary


>
> Thomas
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>


-- 
E-Mail: garydgregory@gmail.com | ggregory@apache.org
JUnit in Action, 2nd Ed: <http://goog_1249600977>http://bit.ly/ECvg0
Spring Batch in Action: <http://s.apache.org/HOq>http://bit.ly/bqpbCK
Blog: http://garygregory.wordpress.com
Home: http://garygregory.com/
Tweet! http://twitter.com/GaryGregory

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message