• Post Reply Bookmark Topic Watch Topic
  • New Topic

Learning to Read API Documentation (And Search by Method Function)  RSS feed

 
Johann Ponderghast
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Is there an online guide or tutorial that teaches how to read the API library? I'm thinking something like this part is this and means this.

Also, how would I search the library by the function of the method? For example, if I wanted to draw something, and I didn't know that I should look for the graphics class, how should I start? If I wanted to draw a moose or octagon? I also read that I needed to do a "extend JFrame." How would I know to do that if I am just starting with an objective, such as draw rectangle or moose and show a string above the image? Thanks for responses.


Johan

 
Campbell Ritchie
Marshal
Posts: 56584
172
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You need the Java™ Tutorials, I think.

And welcome to the Ranch

And please read the important private message I am about to send you.
 
Johann Ponderghast
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Java Tutorials doesn't tell me how to search by method function. Well, thanks for the link.
 
Campbell Ritchie
Marshal
Posts: 56584
172
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
This is the root for the Java6 API documentation.
Click on the name of a class (you will probably get the "frames" version, so look in the lower left frame). Near the top it says
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Click on METHOD (I usually use the left "summary" link) then you can see the methods with their short or long descriptions.
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!