@voir marker, lien autres classes de méthodes

Par exemple, disons que je veux le lien de java.lang.Double de la méthode equals à l'aide d'une balise html:

@see <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Double.html#equals(java.lang.Object)">

C'est ok, mais je n'ai pas compris comment lier une non-standard de la classe.
Par exemple je suis en train d'élaborer deux classes, nommé AbstractVehicle et le Véhicule.Mais il n'y a pas la AbstractVehicle de la documentation javadoc parce que c'est la documentation doit encore être généré.
Alors comment puis-je lien c'est la méthode ou la classe de référence? Considérez ceci:

@see mypackage.AbstractVehilce

Que ce n'est pas la classe URL, je voudrais savoir comment faire pour obtenir l'URL ou de référence avant la génération de la documentation.
J'espère que la question est claire, dites-moi le contraire.

OriginalL'auteur Ramy Al Zuhouri | 2012-04-29

  1. 13

    Pour créer un lien à une classe spécifique, vous pouvez utiliser le {@link mypackage.AbstractVehicle} tag. De même, vous pouvez utiliser {@link mypackage.AbstractVehicle#someMethod} pour créer un lien vers someMethod() dans le AbstractVehicle classe.

    Plus javadoc recommandations peuvent être trouvées à l'Oracle javadoc - L'API Java Générateur de Documentation page.

    Le nom complet du paquet doivent être spécifiés si la JavaDoc est ajoutée à une autre classe du même package?

    OriginalL'auteur matsev

  2. 3

    La page de manuel pour javadoc explique le -link et -linkoffline qui contrôle la façon dont les liens sont générés pour les paquets qui ne sont pas passés à 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  pack-
          age-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 rel-
          ative, 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 doc-
          umentation shares the same file system.

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

          Choosing between -linkoffline and -link - One or the other
          option is appropriate when linking to an API document that
          is external to the current javadoc run.

          Use  -link: when using a relative path to the external API
          document, or when using an absolute URL  to  the  external
          API  document,  if  you  shell does not allow a program to
          open a connection to that URL for reading.

          Use -linkoffline : when  using  an  absolute  URL  to  the
          external API document, if your shell does not allow a pro-
          gram to open a connection to that URL for  reading.   This
          can  occur  if  you are behind a firewall and the document
          you want to link to is on the other side.

          ...

    et alors que -link vous oblige à être connecté au réseau lorsque vous générez la documentation de sorte qu'il peut récupérer la liste des paquets sur le réseau, -linkoffline n'est pas, mais vous oblige à fournir la liste des paquets-vous:

       -linkoffline extdocURL  packagelistLoc
          This option is a varition of -link; they both create links
          to javadoc-generated documentation for external referenced
          classes.  Use the -linkoffline option when  linking  to  a
          document  on  the  web  when  the  Javadoc  tool itself is
          "offline" - that is, it cannot access the document through
          a web connection.

          ...

    OriginalL'auteur Mike Samuel

  3. 2

    Ce que vous pouvez mettre après @see est décrit dans la documentation de l'outil javadoc. Vous ne devriez jamais mettre l'URL de l'extérieure de la classe ou de la documentation de la méthode. Au lieu de cela, vous devriez mettre de la classe, du nom de la méthode, et l'utilisation de la -option de lien laisser javadoc comprendre l'URL appropriée pour vous.

    OriginalL'auteur JB Nizet