1

When I think of Java automatic documentation, I think, well, ugly. Not that it's not useful, but I've been spoiled by readthedocs / sphinx. Is there a package that makes your javadocs pretty?

No offense to the creators of javadoc. It's just clear that function was the focus, and not form.

barryhunter
  • 20,886
  • 3
  • 30
  • 43
Jared Forsyth
  • 12,808
  • 7
  • 45
  • 54
  • 2
    Odd, I consider Javadoc pretty. They did release new stylesheets a year or so ago, but it's still pretty much the same: http://docs.oracle.com/javase/7/docs/api/ – Cory Kendall Mar 14 '13 at 05:44
  • Maybe you could elaborate on what makes the second example "pretty"? Is it just that the colors look more modern? – Nathaniel Waisbrot Mar 14 '13 at 05:44
  • 1
    hmmm thanks for the link @CoryKendall . That's better than I had feared. One huge thing is the use of frames -- it positively shouts 1995. Perhaps usablility is more what I'm looking at (which can be terribly subjective); for example: having a table of contents.. hmm I guess I need to think about this more :) – Jared Forsyth Mar 14 '13 at 05:47
  • @JaredForsyth Ironically the new CSS breaks my workflow, making it less functional for me! In the old style in firefox, I could type `/ StringF6` to jump to the definition of a String and scroll through the available methods. With the new style, this doesn't work at all :( – Cory Kendall Mar 14 '13 at 05:50
  • It seems like they could work a bit on usability so that your very common use case didn't require resorting to a page search... – Jared Forsyth Mar 14 '13 at 05:51

0 Answers0