@see маркер, связать другие методы классов

Question

Допустим, например, что я хочу связать java.lang.Double равняется метод с использованием HTML тег:

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

Это нормально, но я не понял, как для соединения нестандартного класса.
Например, я разрабатываю два класса с именем AbstractVehicle и Vehicle.But. Не существует документации javadoc AbstractVehicle, потому что ее документация еще должна быть сгенерирована.
Тогда как мне связать его метод или ссылку на класс? Рассмотрим это:

@see mypackage.AbstractVehilce 

Это не ставит класс URL, я бы знал, как получить URL или это ссылка перед созданием документации.
Надеюсь, что вопрос ясен, скажите мне иначе.

Answer 1

Чтобы создать link для определенного класса, вы можете использовать тег {@link mypackage.AbstractVehicle}. Аналогично, вы можете использовать {@link mypackage.AbstractVehicle#someMethod} для создания ссылки на someMethod() в классе AbstractVehicle.

Более подробную информацию о javadoc можно найти на странице javadoc - The Java API Documentation Generator Oracle.

Answer 2

manpage для javadoc объясняет -link и -linkoffline, которые контролируют, как создаются ссылки для пакетов, не переданных в 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. 

      ... 

и тогда -link требует от вас быть сеть, подключенная при создании документации, поэтому он может получить список пакетов по сети, -linkoffline не только требует от вас предоставить список пакетов самостоятельно:

-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

Что можно разместить после @see, описано в javadoc tool documentation. Вы никогда не должны ставить URL-адрес какого-либо внешнего класса или документации метода. Вместо этого вы должны поместить имя класса/метода и использовать -link option, чтобы javadoc вычислил соответствующий URL-адрес для вас.