Автоматически генерировать значение @version в javadoc - PullRequest
1 голос
/ 19 сентября 2019

Для тега @version в javadoc я использую то же значение, что и в BuildConfig.VERSION_NAME.Я хотел бы ввести это значение вместо того, чтобы изменять каждый файл для каждого выпуска.

Я пытался:

* @version {@value BuildConfig#VERSION_NAME}

и

* @version @versionName (и добавьте -tag versionName:a:"2.2.2")

но ни одна из этих работ.

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

Есть идеи, как это решить?

1 Ответ

0 голосов
/ 19 сентября 2019

Для второй формы вы можете поместить свой пользовательский тег в начало строки Javadoc.

/**
 * This is a class of Foo<br/>
 *
 * @version
 *
 * @configVersion.
 */

Затем используйте команду javadoc -version -tag configVersion.:a:"2.2.2" для создания вашего Javadoc, пользовательский тег должен обрабатываться в этомпуть.Обратите внимание на последнюю точку (.) в имени пользовательского тега, поскольку команда javadoc предлагает

Примечание. Пользовательские теги, которые могут переопределять будущие стандартные теги: @configVersion.Чтобы избежать возможных переопределений, используйте как минимум один символ точки (.) В именах пользовательских тегов.

...