CODEWITHSUNDEEP
javajavadoc
xdevel2000
xdevel2000

Reputation: 21444

javadoc @docRoot

Can anyone show me an example of that javadoc tag?

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

Upvotes: 3

Views: 4867

Answers (2)

Michael Mrozek
Michael Mrozek

Reputation: 175705

The javadoc documentation has a couple good examples. It always points to the root of the documentation, so if there's something you want to include on every page, you use it to find the javadoc root, since a relative path would be different from page to page

For example, to include your company's logo at the top of every generated documentation page, you might put logo.png in the root of the documentation and then add:

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

to the javadoc header

Upvotes: 6

deepak kumar
deepak kumar

Reputation: 239

These are few tag below

@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 standard :http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#tag

Upvotes: -3

Related Questions