IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Java Discussion :

Javadoc avec @see


Sujet :

Java

Vue hybride

Message précédent Message précédent   Message suivant Message suivant
  1. #1
    Membre averti
    Inscrit en
    Avril 2009
    Messages
    41
    Détails du profil
    Informations forums :
    Inscription : Avril 2009
    Messages : 41
    Par défaut Javadoc avec @see
    salut, je veux générer mon javadoc de mon API en donnant des liens à les méthodes et les classes utilisées (qui est dans API java) pour bien comprendre mon programme. pour ça j'ai utilisé @ see (see also) pour afficher un lien à java doc des méthodes et des classes comme il est utilisé dans javadoc du jre. i.e
    @see LinkedBlockingQueue#offer(Object) normalement me donne un lien à la méthode offer dans la classe LinkedBlockingQueue dans le package java.util.concurrent
    mais en générant java doc elle affiche seulement le texte pas un lien
    See Also:
    LinkedBlockingQueue.offer(Object)
    normalement je veux qu'elle m'affiche :
    See Also:
    LinkedBlockingQueue.offer(Object)
    et qd je clique m'ouvre la page html du javadoc du l'api
    comment faire???

  2. #2
    Expert éminent
    Avatar de tchize_
    Homme Profil pro
    Ingénieur développement logiciels
    Inscrit en
    Avril 2007
    Messages
    25 482
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 46
    Localisation : Belgique

    Informations professionnelles :
    Activité : Ingénieur développement logiciels
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Avril 2007
    Messages : 25 482
    Par défaut
    javadoc ne fait pas de lien au dela des classe dont les sources sont dans ton code. Pour rajouter des javadoc extérieures (par exemple pour lier à la javadoc de sun, il faut utiliser le paramètre -link de l'outil javadoc:

    Citation Envoyé par documentation de l'outil javadoc
    -link extdocURL
    Creates links to existing javadoc-generated documentation of external referenced classes. It takes one argument:

    * extdocURL is the absolute or relative URL of the directory containing the external javadoc-generated documentation you want to link to. Examples are shown below. The package-list file must be found in this directory (otherwise, use -linkoffline). The Javadoc tool reads the package names from the package-list file and then links to those packages at that URL. When the Javadoc tool is run, the extdocURL value is copied literally into the <A HREF> links that are created. Therefore, extdocURL must be the URL to the directory, not to a file.

    You can use an absolute link for extdocURL to enable your docs to link to a document on any website, or can use a relative link to link only to a relative location. If relative, the value you pass in should be the relative path from the destination directory (specified with -d) to the directory containing the packages being linked to.

    When specifying an absolute link you normally use an http: link. However, if you want to link to a file system that has no web server, you can use a file: link -- however, do this only if everyone wanting to access the generated documentation shares the same file system.

    In all cases, and on all operating systems, you should use a forward slash as the separator, whether the URL is absolute or relative, and "http:" or "file:" based (as specified in the URL Memo).

    Absolute http: based link:
    -link http://<host>/<directory>/<directory>/.../<name>
    Absolute file: based link:
    -link file://<host>/<directory>/<directory>/.../<name>
    Relative link:
    -link <directory>/<directory>/.../<name>

    You can specify multiple -link options in a given javadoc run to link to multiple documents.

Discussions similaires

  1. [Javadoc] Problème Javadoc avec du code UTF8
    Par maloups dans le forum EDI et Outils pour Java
    Réponses: 8
    Dernier message: 04/07/2013, 21h09
  2. PreCondition javadoc avec eclipse
    Par jchenoy dans le forum Eclipse Java
    Réponses: 1
    Dernier message: 19/05/2007, 16h35
  3. Problème génération javadoc avec Eclipse
    Par pontus21 dans le forum Eclipse Java
    Réponses: 5
    Dernier message: 05/01/2007, 00h24
  4. Javadoc avec paquetage
    Par mortalius dans le forum Langage
    Réponses: 5
    Dernier message: 12/12/2005, 22h06

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo