Come scrivere i collegamenti javadoc?

Question

Come si scrivono i collegamenti in javadocs?

Attualmente, ho qualcosa di simile:

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

per produrre il testo Math.sqrt che dovrebbe collegare al java.lang.Math.sqrt(double) API, tuttavia, tutto ciò che fa è produrre il testo, nessun collegamento.

Answer 1

per ottenere un link a qualcosa di esterno al codice, è necessario utilizzare l'-linkoffline opzione

in cui l'opzione -linkoffline ha il formato qualcosa di simile (artificialmente avvolto):

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

Questo dice al Strumento JavaDoc in cui trovare il collegamento a JavaDoc e per quali pacchetti utilizzare quel collegamento. Dal 2 URL, si aggiungerà "pacchetto-list" per caricare l'URL reale:

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

quale è possibile verificare caricando in un browser contiene l'elenco dei pacchetti documentati in quel URL JavaDoc. Ciò indica allo strumento JavaDoc che qualsiasi riferimento a @link in uno di questi pacchetti deve essere collegato all'URL fornito.

Answer 2

This document potrebbe essere utile, ricorda che per @link è necessario utilizzare l'URL per il documento a cui si sta collegando.

Answer 3

La mia risposta è molto fornito da Eddie, ma il suo codice esatto non funziona per me (o almeno quando si utilizza la versione di javadoc che viene fornito con Java 1.6)

Se lo faccio:

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

poi javadoc si lamenta:

 javadoc: warning - Error fetching URL: 
    http://java.sun.com/javase/6/docs/api/package-list/package-list

Se, d'altra parte, Faccio:

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

allora funziona, ed i miei collegamenti sono popolati come io voglio che siano.

Inoltre, il mio collegamento non è malformato. Il testo {@link java.lang.Math#sqrt(double) Math.sqrt} produce il testo del collegamento Math.sqrt anziché il valore predefinito Math.sqrt(double).