File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
The moose likes Beginning Java and the fly likes Javadoc Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "Javadoc" Watch "Javadoc" New topic
Author

Javadoc

Ajit Kanada
Ranch Hand

Joined: Jan 23, 2001
Posts: 95
javadoc is supposed to extract the comments from the sourse code.
I have placed comments like/**......*/ in my code.While creating javadoc i m not getting back these coments in HTML file
I dont know why?
Ajit


Thankx
Ajit
Vanitha Sugumaran
Ranch Hand

Joined: Apr 11, 2001
Posts: 356
Hi Ajit,
Are you documenting the code using this command,
javadoc [-author] [-d docDirectory] Filename.java
Vanitha.
Thomas Paul
mister krabs
Ranch Hand

Joined: May 05, 2000
Posts: 13974
Why don't you show us a sample?


Associate Instructor - Hofstra University
Amazon Top 750 reviewer - Blog - Unresolved References - Book Review Blog
Ajit Kanada
Ranch Hand

Joined: Jan 23, 2001
Posts: 95
Ya vanitha ...i m doing the same..
Vanitha Sugumaran
Ranch Hand

Joined: Apr 11, 2001
Posts: 356
Originally posted by Ajit Kanada:
Ya vanitha ...i m doing the same..


Hi Ajith,
Can you post the code? May be we can find what's wrong?
At the starting of the file,
/**
description of the class
@author
@version
*/
for the public methods and constructors
/**
description of the method
@param
@param
@return(if the method returns something)
*/
you can use @see & @link to link another methods or class.
I haven't used @link.
This is what I do .
Vanitha
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Javadoc