• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

question on javadoc

 
Suba Raj
Greenhorn
Posts: 13
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi All,
Im having a doubt with regards to javadoc. My question is how do we create links within the documentation API. When i use the {@link} tag as follows:

I only get plain text displayed. I do not get a hyperlink. I do not know if this is the right way to do it. If not, can someone tell me how do generate a link within the doc. API

Another question that I have is, should we mention the design pattern that we used in the javadoc? Is it enough if we provide documentation so that a junior programmer will be able to build up this application using that API. How extensive should the documentation be to be worth for a good score?

Thanx in advance,
Suba
 
David Ulicny
Ranch Hand
Posts: 724
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Have you seen this?

http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#{@link}
 
Suba Raj
Greenhorn
Posts: 13
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
David,
Thank you very much. This is what I've been looking for.

Regards,
Suba
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic