This week's giveaway is in the EJB and other Java EE Technologies forum.
We're giving away four copies of EJB 3 in Action and have Debu Panda, Reza Rahman, Ryan Cuprak, and Michael Remijan on-line!
See this thread for details.
The moose likes Features new in Java 7 and the fly likes Java 7 introduces a new JavaDoc style Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of EJB 3 in Action this week in the EJB and other Java EE Technologies forum!
JavaRanch » Java Forums » Java » Features new in Java 7
Bookmark "Java 7 introduces a new JavaDoc style" Watch "Java 7 introduces a new JavaDoc style" New topic
Author

Java 7 introduces a new JavaDoc style

Wouter Oet
Saloon Keeper

Joined: Oct 25, 2008
Posts: 2700

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?


"Any fool can write code that a computer can understand. Good programmers write code that humans can understand." --- Martin Fowler
Please correct my English.
Mohamed Sanaulla
Saloon Keeper

Joined: Sep 08, 2007
Posts: 3054
    
  33

looks a lot better. Also the was the "Use" menu there before- to check the usage of a particular class?


Mohamed Sanaulla | My Blog
Wouter Oet
Saloon Keeper

Joined: Oct 25, 2008
Posts: 2700

Yes it was. Although I don't ever use it.
Jaikiran Pai
Marshal

Joined: Jul 20, 2005
Posts: 9313
    
109

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?

[My Blog] [JavaRanch Journal]
Mohamed Sanaulla
Saloon Keeper

Joined: Sep 08, 2007
Posts: 3054
    
  33

I thought it was the CSS- the presentation is better.
Wouter Oet
Saloon Keeper

Joined: Oct 25, 2008
Posts: 2700

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

Joined: Sep 20, 2010
Posts: 3361
    
    9
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

Joined: Aug 02, 2011
Posts: 1

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

Joined: Oct 13, 2005
Posts: 36453
    
  15
Hope I am not too late to welcome you to the Ranch , Emmanuel Bourg.
Stephan van Hulst
Bartender

Joined: Sep 20, 2010
Posts: 3361
    
    9
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!
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Java 7 introduces a new JavaDoc style
 
Similar Threads
Where is the download page that used to be at Sun
strings and regular expressions.
Using constructors to add and manage time
why the length of array is same?
getreceivebuffersize or how to read the buffer size used with the send command