Есть ли способ генерировать вики-страницы слияния из Javadocs?

Question

Я хотел бы поместить документацию на вики слияния для проекта, над которым я работаю, и я хочу автоматически сгенерировать часть документации из javadocs. Есть ли плагин для слияния, который делает это простым (не видел в предварительном поиске), или кто-то написал сценарии для размещения вики-страниц к слиянию на основе javadocs? Задача муравья может быть крутой, тогда я могу иметь вики в качестве цели.

Answer 1

Confluence JavaDocs Macros - это плагин, который будет генерировать вики-страницы из javadocs. Недостатком является то, что zav-архив должен быть составлен из javadocs и размещен на первой странице пространства, а несколько javadocs не могут сосуществовать в одном и том же пространстве.

Плагин также не совместим с каждой версией Confluence.

И вы можете добавить javadocs к слиянию, если у вас был только сервер слияния (или сервер слияния является основным местом для документации) для размещения вашей документации ... Это случилось раньше.

Answer 2

Вы можете использовать плагин Docs: https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin. Этот плагин позволяет загружать и публиковать ваши JavaDocs и другой контент на основе HTML и JavaScript в Confluence.

Документы также предоставляют интерфейс REST для автоматизации процесса публикации. Таким образом, публикация JavaDocs может стать частью процесса непрерывной интеграции. Техническую документацию, а также пример кода вы можете найти здесь: https://ricebean.net/confluence-docs

Answer 3

Зачем вам загружать Javadoc в систему редактирования? Это звучит довольно странно. Мы создали сервер apache, на который загружена документация по проекту (который создается из Java как javadoc, и из некоторой проектной документации (которую мы также храним в проекте (внутри SCM)).

Кроме того, у нас есть система Wiki, в которой каждый может писать разные вещи. В большинстве вики легко сделать внешнюю ссылку (на веб-сервер Apache, документацию по проекту / страницы javadoc).

Хорошо, что проектная документация может быть заново сгенерирована через ant / maven / и т. Д. И автоматически загружена на какой-либо веб-сервер. Там может быть только красный и не модифицированный. Это может быть сделано только через источники проекта. Это хорошо, потому что в противном случае люди начинают редактировать вики-страницы, которые потом время от времени заменяются, потому что создается новая сборка / релиз.