commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Simone Tripodi <simonetrip...@apache.org>
Subject Re: Apache Commons Javadoc template?
Date Sun, 11 Mar 2012 00:18:36 GMT
Salut,

I couldn't resist and I started implementing a style spike under Maven
sandbox[1]; you can have a look at a preview on my personal ASF
space[2].

Work is still in progress but, as you can see, there are good
potentials to improve textual documentation - WDYT?

It is not too different from the original doclet but less '90-ish...

Hope you like it!
best,
-Simo

[1] https://svn.apache.org/repos/asf/maven/sandbox/trunk/skins/fluido-doc
[2] http://people.apache.org/~simonetripodi/fluido-docs/

http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/



On Fri, Mar 9, 2012 at 2:31 PM, Gary Gregory <garydgregory@gmail.com> wrote:
> On Fri, Mar 9, 2012 at 7:43 AM, Emmanuel Bourg <ebourg@apache.org> wrote:
>
>> Le 09/03/2012 12:29, Gary Gregory a écrit :
>>
>>  This is pretty subjective stuff. Personally I like the stock Java 7
>>> best of all (java 6, java 7 "fix").
>>>
>>
>> To be clear, you find this :
>>
>> http://s3.amazonaws.com/uso_**ss/13457/large.png<http://s3.amazonaws.com/uso_ss/13457/large.png>
>> (left aligned return type, non indented method description, wide gap
>> between the return type column and the description column, bold characters
>> for methods and objects)
>>
>> more readable than this?:
>>
>> http://s3.amazonaws.com/uso_**ss/13458/large.png<http://s3.amazonaws.com/uso_ss/13458/large.png>
>>
>
> To me, yes, the former is better than the later. Different strokes for
> different folks.
>
> For me the extra indentation is noisy and ugly.
>
>
>>
>> I would be interested to understand what makes you prefer the stock Java 7
>> style, I could improve the fix. For example the added cell borders are
>> probably debatable.
>>
>
> It's all debatable IMO :)
>
> For my taste, I do not like that the "Modifier and Type" column stretches
> so far from the "Method and Description" column, it makes them feel
> detached on a wide screen. But I'm not going to fiddle with CSS to "fix" it
> because it's not broken, it's just a personal preference...
>
> Gary
>
>
>>
>>
>> Emmanuel Bourg
>>
>>
>
>
> --
> 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

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


Mime
View raw message