Win a copy of Clojure in Action this week in the Clojure forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Javadoc

 
Ajit Kanada
Ranch Hand
Posts: 95
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
Vanitha Sugumaran
Ranch Hand
Posts: 356
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ajit,
Are you documenting the code using this command,
javadoc [-author] [-d docDirectory] Filename.java
Vanitha.
 
Thomas Paul
mister krabs
Ranch Hand
Posts: 13974
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Why don't you show us a sample?
 
Ajit Kanada
Ranch Hand
Posts: 95
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Ya vanitha ...i m doing the same..
 
Vanitha Sugumaran
Ranch Hand
Posts: 356
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic