Comment écrire des liens javadoc?

Question

Comment écrire des liens dans des javadocs?

Actuellement, j'ai quelque chose comme:

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

pour produire le texte Math.sqrt qui doit être lié à l'API java.lang.Math.sqrt(double) , il ne produit toutefois que le texte, pas de lien.

Answer 1

Ma réponse est très fournie par Eddie, mais son code ne fonctionne pas pour moi (ou au moins lors de l'utilisation de la version de javadoc qui vient avec la version 1.6 de Java)

Si je fais:

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

puis javadoc se plaint:

 javadoc: avertissement d'Erreur de l'extraction de l'URL: 
 http://java.sun.com/javase/6/docs/api/package-list/package-list

Si, d'autre part, je fais:

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

Puis il travaille, et mes liens sont peuplées que je veux être.

En outre, mon lien n'est pas incorrect. Le texte {@link java.lang.Math#sqrt(double) Math.sqrt} produit le texte du lien, Math.sqrt , au lieu de la valeur par défaut Math.sqrt(double).

Answer 2

Pour obtenir un lien vers quelque chose d'extérieur à votre code, vous devez utiliser l' -linkoffline option

où l' -linkoffline option a le format quelque chose comme ceci (artificiellement emballée):

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

Cela indique à l'outil JavaDoc où trouver le lien vers la JavaDoc et pour quels paquets d'utiliser ce lien. A partir de la 2ème URL, il ajoutera le "package-list" pour charger l'URL:

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

ce que vous pouvez vérifier en le chargeant dans un navigateur contient la liste des paquets documenté à ce JavaDoc URL. Cela indique à l'outil JavaDoc que tout @link références à quoi que ce soit dans l'un de ces paquets doivent lien vers l'URL fournie.

Answer 3

Ce document peut vous être utile. N'oubliez pas que pour @link, vous devez utiliser l'URL du document auquel vous créez un lien.