Наследование javadoc из библиотек в архивные файлы - PullRequest
Новая
       33

Наследование javadoc из библиотек в архивные файлы

1 голос
/ 09 марта 2012

Можно наследовать документацию JDK в методах, которые вы переопределили / реализовали при создании Javadoc. (например этот вопрос .)

Это работает путем добавления каталога, содержащего источник JDK, в Javadoc -sourcepath. Я предполагаю, что то же самое произойдет, если я разархивирую исходный код для любой из моих библиотечных зависимостей.

Можно ли наследовать документацию без разархивирования всего исходного кода? Это позволило бы полную документацию, используя путь, который я могу создать из Ivy / Maven или любого другого.

Возможно, можно обмануть Javadoc, используя какой-нибудь zip-путь?

Я понимаю, что могу ссылаться на документацию в другом месте в Интернете - также полезную, но другую.

Ответы [ 3 ]

1 голос
/ 01 февраля 2017

Я выполняю это с моей конфигурацией проекта maven, подобной этой, чтобы основная документация java, которая связана, всегда соответствовала моей версии компиляции.И я хочу связать всю документацию по селену, поскольку она является частью инфраструктуры объектов страницы, которая в значительной степени зависит от нее.Я уверен, что мы могли бы адаптировать этот подход к настройке, которая у вас есть. 

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <links>
            <link>http://seleniumhq.github.io/selenium/docs/api/java/</link>
            <link>https://docs.oracle.com/javase/${project.java.version}/docs/api/</link>
        </links>
    </configuration>
</plugin>

По своей сути это то же самое, что использовать параметры командной строки для javadoc для ссылки на вещи в Интернете, напримерв ответ на этот вопрос , который вы связали.Просто нужно параметризовать URL-адрес, на который он ссылается.

Для командной строки javadoc, я думаю, это переводится так (синтаксис Unix, одна строка): 

javadoc -sourcepath ../example-src/src:src
        -d docs
        -link http://example.com/javadoc/
        -subpackages com.personal.myproject
        (other options...)

Doh!Просто понял, что все это предполагает, что ваши внешние библиотеки где-то размещают свою документацию.Я думаю, если это не так, может быть, вы можете изучить создание javadoc-jar для внешней библиотеки и связывание с uri в стиле jar.По крайней мере, тогда вы вводите в проект только один новый артефакт.

1 голос
/ 09 мая 2017

В JDK 1.8.0u121 -sourcepath принимает ZIP-файлы, такие как src.zip, который поставляется вместе с JDK.

1 голос
/ 09 марта 2012

Из документации Javadoc :

Явно наследуйте комментарий с тегом {@inheritDoc} - вставьте встроенный тег {@inheritDoc} в основное описание метода или @return, @param или @throws комментарий комментария - соответствующий унаследованный основной описание или тег-комментарий копируется в это место.

Исходный файл для унаследованного метода должен находиться только по пути, указанному -sourcepath , чтобы комментарий к документу был фактически доступен для копирования. Ни класс, ни его пакет не должны передаваться в командной строке.

...