Win a copy of Re-engineering Legacy Software this week in the Refactoring forum
or Docker in Action in the Agile forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Java 7 introduces a new JavaDoc style

 
Wouter Oet
Saloon Keeper
Posts: 2700
IntelliJ IDE Opera
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
That Java 7 would introduce a new JavaDoc style has been known for a while now. But yesterday Mark Reinhold showed us what it would look like. I like it. What do you think?
 
Mohamed Sanaulla
Saloon Keeper
Posts: 3159
33
Google App Engine Java Ruby
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
looks a lot better. Also the was the "Use" menu there before- to check the usage of a particular class?
 
Wouter Oet
Saloon Keeper
Posts: 2700
IntelliJ IDE Opera
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yes it was. Although I don't ever use it.
 
Jaikiran Pai
Marshal
Pie
Posts: 10444
227
IntelliJ IDE Ubuntu
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Am I missing something or is it just the presentation (css) style that has changed? Or are we talking about any javadoc comment convention/style change? If it's just the presentation that's changed, I guess that was customizable earlier too isn't it?
 
Mohamed Sanaulla
Saloon Keeper
Posts: 3159
33
Google App Engine Java Ruby
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I thought it was the CSS- the presentation is better.
 
Wouter Oet
Saloon Keeper
Posts: 2700
IntelliJ IDE Opera
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Well the old JavaDoc didn't use CSS. So that is new.

Here is the link to the post of Mark Reinhold. It contains some links to what actually changed in the JavaDoc tool.
 
Stephan van Hulst
Bartender
Pie
Posts: 5387
52
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I've been using it for a while now to get used to it, and while I really like the new style, there are two things that bother me a little bit. First, I would like the method return types to be right-aligned, like they used to be. I really notice that my eyes have to travel around a lot more using the new docs.

Secondly, links should be more emphasized. Maybe black or bold? Right now I easily read over links, and the method names in the summaries draw a lot less attention than they used to.
 
Emmanuel Bourg
Greenhorn
Posts: 1
Debian Firefox Browser IntelliJ IDE
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Stephan you might want to try this custom style, I believe it fixes most of the issues you spotted:

http://userscripts.org/scripts/show/108797
 
Campbell Ritchie
Sheriff
Posts: 48402
56
  • Likes 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hope I am not too late to welcome you to the Ranch , Emmanuel Bourg.
 
Stephan van Hulst
Bartender
Pie
Posts: 5387
52
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Emmanuel,

Thanks a lot! I slightly modified your style and now it's pretty much perfect for me. I'm using the following additions from your CSS (which I just pasted to the end of the .css that comes with the Java 7 api):
I deleted the piece that makes most bold links normal again (I like them bold); I also added the last clause, making the links in summary tables and detailed member descriptions underlined.

Thanks again!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic