How do I use javadoc?
Author |
Message |
Fonzie
|
Posted: Sat Jan 27, 2007 9:13 pm Post subject: How do I use javadoc? |
|
|
I'm having difficulty using this. I type "$javadoc Testing.java" in the command prompt and I get an error that it doesn't recognize the command. Do I have to download something? I thought it was automatically downloaded when I got java. |
|
|
|
|
|
Sponsor Sponsor
|
|
|
HellblazerX
|
Posted: Sat Jan 27, 2007 9:57 pm Post subject: Re: How do I use javadoc? |
|
|
You need to state the location when the javadoc file is before you can call upon it. In my case, it would be this:
C:/j2sdk1.4.2_08/bin/$javadoc Testing.java |
|
|
|
|
|
Fonzie
|
Posted: Tue Jan 30, 2007 1:17 am Post subject: Re: How do I use javadoc? |
|
|
thankyou, though now I'm having difficulty using this, and can't seem to find instructions. I have my method, and right above it, are these 3 comments:
/**Enables you to do something*/
/**@param placeholder holds a place*/
/**@return a number*/
however, only the return is documented. It seems that only the last comment is put into the api. Is there some syntax I don't know? |
|
|
|
|
|
ericfourfour
|
Posted: Wed Feb 07, 2007 6:11 pm Post subject: RE:How do I use javadoc? |
|
|
The correct way to comment that is:
Java: | /**
* Enables you to do something.
* @param placeholders holds a place.
* @return a number
*/ |
|
|
|
|
|
|
|
|