marcador @see, enlazar otros métodos clases

Question

Digamos por ejemplo que yo quiero vincular java.lang.Double de igual método que usa una etiqueta html:

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

Esto está bien, pero no he entendido cómo para vincular una clase no estándar.
Por ejemplo, estoy desarrollando dos clases, llamadas AbstractVehicle y Vehicle. Pero no existe la documentación de javadoc de AbstractVehicle porque aún no se ha generado la documentación.
¿Cómo puedo vincular el método o la referencia de clase? Considere esto:

@see mypackage.AbstractVehilce 

esto no pone la URL clase, me gustaría saber cómo obtener la dirección URL o es referencia antes de generar la documentación.
Espero que la pregunta sea clara, dígame lo contrario.

Answer 1

Para crear un link a una clase específica, puede usar la etiqueta {@link mypackage.AbstractVehicle}. Del mismo modo, puede usar {@link mypackage.AbstractVehicle#someMethod} para crear un enlace al someMethod() en la clase AbstractVehicle.

Más recomendaciones de javadoc se pueden encontrar en la página de Oracle javadoc - The Java API Documentation Generator.

Answer 2

La página de manual para javadoc explica -link y -linkoffline que controlan cómo se generan los enlaces para paquetes no pasados ​​a 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. 

      ... 

y que -link se requiere para ser conectados a la red cuando se genera la documentación para que pueda recuperar la lista de paquetes en la red, -linkoffline no, pero que requiere para suministrar la lista de paquetes a sí mismo:

-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. 

      ... 

Answer 3

Lo que puede poner después de @see se describe en el javadoc tool documentation. Nunca debe poner la URL de ninguna clase externa o documentación de método. En su lugar, debe poner el nombre de clase/método, y usar el -link option para que javadoc determine la URL adecuada para usted.