Как написать ссылки javadoc?

Ответ 1

Чтобы получить ссылку на что-то внешнее по отношению к вашему коду, вам нужно использовать опцию -linkoffline

где опция -linkoffline имеет формат, подобный этому (искусственно завернутый):

-linkoffline http://java.sun.com/javase/6/docs/api/
             http://java.sun.com/javase/6/docs/api/

Это сообщает инструменту JavaDoc, где можно найти ссылку на JavaDoc и какие пакеты использовать эту ссылку. Со второго URL-адреса он добавит "список пакетов" для загрузки фактического URL-адреса:

http://java.sun.com/javase/6/docs/api/package-list

который вы можете проверить, загрузив его в браузере, содержит список пакетов, зарегистрированных на этом URL-адресе JavaDoc. Это говорит утилите JavaDoc, что любые ссылки @link на что-либо в одном из этих пакетов должны ссылаться на предоставленный URL.

Ответ 2

Мой ответ очень дается Эдди, но его точный код не работает для меня (или, по крайней мере, при использовании версии javadoc, которая поставляется с Java 1.6)

Если я это сделаю:

 javadoc -linkoffline http://java.sun.com/javase/6/docs/api/                       http://java.sun.com/javase/6/docs/api/package-list          -public FileName.java

то javadoc жалуется:

 javadoc: warning - Ошибка выборки URL:   http://java.sun.com/javase/6/docs/api/package-list/package-list

Если, с другой стороны, я:

 javadoc -linkoffline http://java.sun.com/javase/6/docs/api/                       http://java.sun.com/javase/6/docs/api/          -public FileName.java

Затем он работает, и мои ссылки заполняются так, как я хочу, чтобы они были.

Кроме того, моя ссылка не искажена. Текст {@link java.lang.Math#sqrt(double) Math.sqrt} создает текст ссылки Math.sqrt вместо стандартного Math.sqrt(double).

Ответ 3

Этот документ может помочь, помните, что для @link вам нужно использовать URL-адрес для документа, к которому вы привязываетесь.