¿Cómo escribir enlaces a javadoc?

Question

¿Cómo escribo enlaces en javadocs?

Actualmente, tengo algo como:

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

para producir el texto Math.sqrt que debe vincular a la API java.lang.Math.sqrt(double), sin embargo, lo único que hace es producir el texto, hay un vínculo.

Answer 1

Para obtener un enlace a algo externo a su código, es necesario utilizar la opción -linkoffline

donde la opción -linkoffline tiene el formato algo como esto (envuelto artificialmente):

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

Esto le dice al La herramienta JavaDoc donde encontrar el enlace a JavaDoc y qué paquetes usar ese enlace. A partir de la segunda URL, añadirá "paquete-list" para cargar el URL real:

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

que se puede verificar mediante la carga en un navegador contiene la lista de paquetes documentados en ese URL JavaDoc. Esto le dice a la herramienta JavaDoc que cualquier referencia de @link a cualquier elemento en uno de esos paquetes debe vincular a la URL proporcionada.

Answer 2

This document puede ser de ayuda, recuerde que para @link necesita utilizar la URL para el documento al que está vinculando.

Answer 3

Mi respuesta es mucho proporcionada por Eddie, pero su código exacto no funciona para mí (o por lo menos cuando se utiliza la versión de javadoc que viene con Java 1.6)

Si hago:

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

continuación javadoc se queja:

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

Si, por el contrario, Yo:

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

entonces funciona, y mis enlaces están pobladas como yo quiero que sean.

Además, mi enlace no está mal formado. El texto {@link java.lang.Math#sqrt(double) Math.sqrt} produce el texto de enlace Math.sqrt en lugar del Math.sqrt(double) predeterminado.