Javadoc и maven: сделать ссылку на класс кликабельной, когда она указывает на другую банку - PullRequest
Новая
       32

Javadoc и maven: сделать ссылку на класс кликабельной, когда она указывает на другую банку

0 голосов
/ 07 июня 2018

У меня есть две фляги, одна для интерфейсов и одна для реализаций.Например, в первом банке у меня есть: 

package com.myapp.jar1
public inteface MyInterface {...}

во втором банке у меня есть 

package com.myapp.jar2
import com.myapp.jar1.MyInterface

public class MyClass implements MyInterface {...}

Когда Javadoc создаются с помощью Maven, ссылка на класс в том же пакетепреобразуется в ссылки (как и ожидалось), в то время как ссылка на класс в другом пакете представляет собой простой текст.

Полагаю, проблема в том, что javadoc не знает, где и кто такой MyInterface.Существует ли способ сообщить javadoc, чтобы проверить в других пакетах doc?

Подробности:

В Apache у меня есть каталог javadoc, и я разархивирую там все свои банки: 

/var/www/html/javadoc/jar1
/var/www/html/javadoc/jar2

Таким образом, моя ссылка будет указывать на другую позицию на том же сервере или на внешний ресурс, если это пакет третьего производства (например, Джексон)

1 Ответ

0 голосов
/ 07 июня 2018

Используйте этот способ для поиска других пакетов : 

{@link [<package>.]<class>[#<method>] label}
{@link [<package>.]<class>[#<method>]}
{@link #<method>}

Пример: 

{@link com.project.Interfaces.MyInterface MyInterface}

Если вы хотите показать полный путь, не используйте метку.

Javadoc в другом .jar:

  1. Щелкните правой кнопкой мыши проект:
  2. Путь сборки> Настройка пути сборки
  3. Библиотеки> Выберите библиотеку и разверните ее
  4. Выберите «Местоположение Javadoc»> нажмите кнопку «Изменить» справа.
  5. Добавьте файл JAR с помощью документов
  6. Нажмите на кнопку «Проверить», чтобы проверить, есть ли какие-либо проблемы

Этот jar это переименованное расширение файла zip и необходимоиметь index.html в корневом каталоге.

Ссылки:

...