2015-08-14 5 views
0

Как я могу связать конкретный раздел в файле package-info.java от Javadoc в других местах?Ссылка на конкретный раздел в package-info.java

Этот раздел может быть указан с помощью тега <a name="section-name">..., тогда ссылка должна иметь адрес ... /package-summary.html#section-name. Но интересны и другие способы указания разделов.

Требования:

  1. Должна быть обеспечена возможность связать с другими, чем один документированный с package-info.java файла пакетов.
  2. URL-адреса относительно источника ссылок (например, ..\..\p1\p2\package-info.java) не могут быть использованы, так как их было бы так сложно поддерживать.
  3. Ссылка должна быть указана не только веб-браузером, но и IDE (что наиболее важно Eclipse) в их автогенерированном всплывающем представлении Javadoc.

    Я думаю, что единственным способом достичь этого было бы не использовать href и вместо этого использовать {@linkplain}, но я не могу понять, как указать раздел.

ответ

1

Можно сделать это с помощью href и @{docRoot} тег:

<a href="{@docRoot}/p1/p2/package-summary.html#section-name">Section Name</a> 

Это не соответствует требованиям 3, хотя, так как в Eclipse, следуя такой ссылке открывается веб-браузер вместо построение в Javadoc viewer. Поэтому, если кто-нибудь найдет другое решение, я был бы благодарен.

Смежные вопросы