Go to Post I'm currently working on design for a bin made out of concrete that will not break for next year's competition... :D - dlavery [more]
Home
Go Back   Chief Delphi > Technical > Programming > Java
CD-Media   CD-Spy  
portal register members calendar search Today's Posts Mark Forums Read FAQ rules

 
 
 
Thread Tools Rate Thread Display Modes
Prev Previous Post   Next Post Next
  #5   Spotlight this post!  
Unread 20-01-2011, 10:41
drakesword drakesword is offline
Registered User
AKA: Bryant
FRC #0346 (Robohawks)
Team Role: Mentor
 
Join Date: Jan 2006
Rookie Year: 2004
Location: USA
Posts: 200
drakesword is on a distinguished road
Re: How to use JAVADOCS?

Javadocs are the bible of java there are 3 main sections.

1 Constructors
2 Fields
3 Methods

Constructors explain what parameters (if any) are needed to be passed to create the object. From the example above ...

Code:
Joystick joy = new Joystick(1);
Take a peek into the javadoc to see . . .

Code:
Joystick
public Joystick(int$@#port)
Construct an instance of a joystick. The joystick index is the usb port on the drivers station.

Parameters:
port - The port on the driver station that the joystick is plugged into.
So if you look at an example then the javadoc everything starts to become self explanatory.

Also note that if you run into a method or field that is declared static then you do not need to construct an object to use those methods or fields.

An example of static call would be

Code:
System.out.println("Something");
the System.out object is declared static so there is no

Code:
System.out = new ...
Reply With Quote
 


Thread Tools
Display Modes Rate This Thread
Rate This Thread:

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Forum Jump


All times are GMT -5. The time now is 12:45.

The Chief Delphi Forums are sponsored by Innovation First International, Inc.


Powered by vBulletin® Version 3.6.4
Copyright ©2000 - 2017, Jelsoft Enterprises Ltd.
Copyright © Chief Delphi