Tek-Tips is the largest IT community on the Internet today!

Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!

  • Congratulations gkittelson on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!

javadoc problems

Status
Not open for further replies.

afe

Programmer
Mar 24, 2001
12
US
I've tried a lot of times to get documentation with the aid of
javadoc, but it doesn't work. Please, give some examples of using javadoc.
 
Hi,

Do you mind elaborating what you mean by it doesn't work? Some possible reasons I could think of are that you have typed the wrong command or that you forgot to add 'codes' into your java program. (this is a must because the compiler is not so smart as in to know what the various methods are for and what the passed in variables meant)

Regards,
Leon If you need additional help, you can email to me at zaoliang@hotmail.com I don't guaranty that I will be able to solve your problems but I will try my best :)
 
Firstly, are you pathed right? If you've been compiling java code then probably you are, but in the DOS prompt just type 'javadoc' and see what parameters it takes.

Secondly, cd into your root source code directory and enter:
javadoc <package name> <package name> -d <doc directory path>

It doesn't matter if you haven't enetered comments and codes into your source code yet as javadoc will generate pages with your classes and methods in, but uncommented.

Come back for more advice when that works.... My home ----> visit me for Java and Data Warehousing resources
 
Status
Not open for further replies.

Part and Inventory Search

Sponsor

Back
Top