Javadoc @docRoot

Question

Can someone show me an example of this javadoc tag?

I don't understand very well how to use it in code

Answer 1

The javadoc documentation contains a couple of good examples. It always points to the root of the documentation, so if there is something you want to include on each page, you use it to find the javadoc root, since the relative path will differ from page to page

For example, to include your company logo at the top of each created documentation page, you can put it logo.pngin the root folder of the documentation, and then add:

<img src="{@docRoot}/logo.png">

in javadoc header

Answer 2

@author  //this will give name of author

@see     //it is used to point to refrence

@since   //this will give from which version it is included

@link    // this is used to provide link to another file

example: http://www.docjar.net/html/api/java/util/Collections.java.html

doc: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#tag