Eclipse: Может ли один JAR иметь более одного местоположения JavaDoc? - PullRequest
Новая
       10

Eclipse: Может ли один JAR иметь более одного местоположения JavaDoc?

3 голосов
/ 11 февраля 2009

Я использую Eclipse 3.4.1.

Хотя это может показаться странным, но я хочу иметь возможность подключить более одного расположения JavaDoc к одному и тому же JAR-файлу в проекте Eclipse. Этот конкретный JAR имеет классы из двух наборов JavaDoc. Причина этого в том, что это пакет OSGi, который состоит из стороннего JAR и некоторого другого стороннего кода поверх этого JAR, чтобы он работал в OSGi.

Если у меня есть исходный код для обоих пакетов, и у меня есть этот исходный код в проекте Eclipse, он работает нормально. Но я бы хотел, чтобы это работало, если у меня есть только JAR и JavaDoc.

1 Ответ

1 голос
/ 11 февраля 2009

Нетривиально сделать, поскольку информация о javadocs хранится в classpathentry файла .classpath вашего проекта и состоит из одного значения (каталога или архива)

Решение состоит в том, чтобы создать один Javadoc, который включает в себя как текущие Javadocs, так и прикрепить этот архив к банке.

Другое решение (которое может быть неправильно интерпретировано Eclipse: будет проверено) - ссылки на внешние документы

Пример использования относительных ссылок на внешние документы :

Допустим, у вас есть два пакета, документы которых генерируются при разных запусках инструмента Javadoc, и эти документы разделяются относительным путем.
В этом примере пакетами являются com.apipackage, API, и com.spipackage, SPI (Service Provide Interface).
Вы хотите, чтобы документация находилась в docs/api/com/apipackage и docs/spi/com/spipackage.
Предполагая, что документация пакета API уже сгенерирована, и что docs является текущим каталогом, вы должны задокументировать пакет SPI со ссылками на документацию API, выполнив: 

C:> javadoc -d ./spi -link ../api com.spipackage

Обратите внимание, что аргумент -link относительно каталога назначения (docs / spi).

Так что может быть , если вы прикрепите только второй javadoc к банке, он может выбрать классы, описанные в первом javadoc ... но я сомневаюсь в этом. http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#linkrelativeexample

...