javadoc @docRoot

Question

Can anyone show me an example of that javadoc tag?

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

Answer 1

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