Пакет JavaDoc @link в Android Studio

Question

Мне нужна ссылка на пакет в JavaDoc.

Пример:

@param example description (see {@link com.example.packagename this})

С кодом выше я получаю это сообщение:

warning - Tag @link: reference not found: com.example.packagename

Связь с классом в том же пакете работает нормально, но мне нужно напрямую связаться с пакетом.

Answer 1

Это невозможно с @link.

Создать package.html файл или один package-info.java в вашем com.example.packagename

/**
 * This is packagename
 */
package com.example.packagename;

Затем вы можете связаться с этим пакетом поиспользуя @see.

/**
 * @param example description
 * @see com.example.packagename
 */
void doWork(String example) {

}

Теперь ваша андроид студия покажет документацию следующим образом:

Нажав на com.example.packagename, будет показан Javadoc внутри package-info.java.

Примечание. Вместо непосредственного связывания имени пакета можно использовать тег <a>:

 * @see <a href="{@docRoot}/com/example/packagename/package-summary.html">Packagename</a>