• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

Better docs than Sun provides

 
Greenhorn
Posts: 6
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
The hypertext documentation on the java class libraries provided by Sun really sucks. Does any one know of any one line documentation that is better? :roll:
Steven Davidson
 
Sheriff
Posts: 17644
300
Mac Android IntelliJ IDE Eclipse IDE Spring Debian Java Ubuntu Linux
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Steven,
What exactly don't you like about the online API JavaDocs?
Considering that they are generated by a utility called JavaDoc from comments in the source code, I think they are pretty decent. You could buy an "API Reference" book for $50 but that would get obsolete quickly. The latest version of the API documentation will always be available online and I prefer it that way.
Junilu
 
Ranch Hand
Posts: 2823
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Does any one know of any one line documentation that is better?



I don't think you could get better in one line.
 
"The Hood"
Posts: 8521
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Very funny Paul .
Actually whole BOOKS have been written trying to explain the API better.
The Java Class Libraries, Volume 1 and Volume 2 are based on jdk1.1 but I don't know of any more recent COMPLETE API references.
 
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I think SUN shound provid an example for each class.
 
Bartender
Posts: 2205
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
JavaDocs for the java platform API are no-frills tools for developers who are familiar with the APIs. They are reference material. They are not tutorials. As reference material, they serve their function beautifully. JavaDoc is one of the greatest tools that sun has developed in API documentation.
 
Ranch Hand
Posts: 3244
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
DingDing
Welcome to the Java Ranch, we hope you’ll enjoy visiting as a regular however,
your name is not in keeping with our naming policy here at the ranch. Please re-register under an appropriate name as shown in the policy.
Thanks again and we hope to see you around the ranch!!
 
Ranch Hand
Posts: 399
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Originally posted by Cindy Glass:
Very funny Paul .
Actually whole BOOKS have been written trying to explain the API better.
The Java Class Libraries, Volume 1 and Volume 2 are based on jdk1.1 but I don't know of any more recent COMPLETE API references.


I've found the books Cindy cites very useful as references on the APIs. They explain the API classes in much more detail than is in the standard library doc pages. There is a substantial supplement to the first volume for 1.2. Unfortunately, they are too big to carry around. So I never seem to have them when I need them, which is a shame, considering what I paid for them.
 
With a little knowledge, a cast iron skillet is non-stick and lasts a lifetime.
reply
    Bookmark Topic Watch Topic
  • New Topic