Можно ли связать файл README в javadocs?

В настоящее время я использую свой файл README как набор инструкций и хотел бы сослаться на него в javadocs. Я знаю, что в javadoc можно связать каталоги, например, связать изображение, которое я могу сделать

/**
 * <img src = "../../../images/Diagram.png"/>
 */

Но как связать файл README, который находится в корне проекта? Является ли это возможным?

android javadoc

28.06.2019 18:38

Коллекции (ArrayList , HashSet , HashMap)

991

Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

На основе AdoptOpenJDK Collection исходный код похоже, что HTML-тег привязки <a></a> используется для ссылки на файлы в различных частях. Например, в строках 192-193 есть:

<a href = "{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
Java Collections Framework</a>.

Вы также можете увидеть это в других комментариях javadoc по всему исходному коду, поэтому вы должны иметь возможность использовать путь к файлу класса, отличному от Java, на который вы хотите связать с тегом привязки.

26.03.2020 00:39

Другие вопросы по теме

Плагин Maven javadoc 3.1.0 не генерирует сводные javadocs

Как добавить javadocs зависимостей в Visual Studio Code?

Как удалить тег @link и его содержимое между { и } из комментария javadoc?

Как убедиться, что все собственные исключения времени выполнения включены в Javadoc?

Как определить комбинацию клавиш в Eclipse для создания ВСЕХ javadoc для моего проекта

Как иметь разные URL-адреса для каждого класса в сгенерированной документации API?

RegEx для добавления символа в определенных местах

Gradle Kotlin DSL: подкаталог для javadoc в файле jar

Отсутствует базовый Javadoc в Eclipse для Java 11

Javadoc: разница между «методами, унаследованными от» и «методами, объявленными в»

Можно ли связать файл README в javadocs?

Ответы 1

Другие вопросы по теме

Похожие вопросы