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

Question

Как мне написать ссылки в javadocs?

В настоящее время у меня есть что-то вроде:

{@link java.lang.Math#sqrt(double) Math.sqrt}

для создания текста Math.sqrt, который должен ссылаться на java.lang.Math.sqrt(double) API, однако все, что он делает, это создает текст, без ссылки.

Answer 1

Мой ответ в значительной степени предоставлен Эдди, но его точный код не работает для меня (или, по крайней мере, при использовании версии 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 - Error fetching 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).

Answer 2

Чтобы получить ссылку на что-то внешнее по отношению к вашему коду, вам нужно использовать опцию -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.

Answer 3

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