Есть ли способ генерации страниц wiki слияния из javadocs?

Question

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

Answer 1

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

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

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

Answer 2

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

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

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

Answer 3

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

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