Я хотел бы разместить документацию на вики-странице слияния для проекта, над которым я работаю, и я хочу автоматически генерировать часть документации из javadocs. Есть ли плагин для слияния, который упрощает это (не видел при предварительном поиске), в качестве альтернативы, кто-нибудь написал сценарии для публикации вики-страниц для слияния на основе javadocs? Задача с муравьями могла бы быть крутой, тогда я мог бы использовать вики в качестве цели.
Есть ли способ сгенерировать вики-страницы слияния из javadocs?
Ответы (3)
Confluence JavaDocs Macros - это плагин, который будет генерировать вики-страницы из javadocs. Обратной стороной является то, что zip-архив должен состоять из документов javadoc и размещаться на первой странице пространства, а несколько документов javadoc не могут сосуществовать в одном пространстве.
Плагин также совместим не со всеми версиями Confluence.
И вы, возможно, захотите добавить javadocs в конфлюенс, если у вас есть только сервер слияния (или сервер слияния является основным местом для документации) для размещения вашей документации ... Это уже случалось раньше.
person
ggissel
schedule
18.12.2009
Вы можете использовать подключаемый модуль Документов: https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin. Этот плагин позволяет загружать и публиковать документы JavaDocs и другой контент на основе HTML и JavaScript в Confluence.
Docs также предоставляет интерфейс REST для автоматизации процесса публикации. Таким образом, публикация JavaDocs может стать частью процесса непрерывной интеграции. Техническую документацию, а также образец кода можно найти здесь: https://ricebean.net/confluence-docs < / а>
person
meixxi
schedule
09.05.2015
Зачем загружать javadoc в систему редактирования? Это звучит странно. Мы создали сервер apache, на который выгружается проектная документация (которая создается из Java как javadoc и из некоторой проектной документации (которую мы также храним в проекте (внутри SCM)).
Рядом с этим у нас есть Wiki-система, в которой каждый может писать что угодно. В большинстве вики легко сделать внешнюю ссылку (на веб-сервер Apache, страницы документации проекта / javadoc).
Хорошо то, что документацию по проекту можно повторно сгенерировать с помощью ant / maven / и т. Д. И автоматически загрузить на какой-либо веб-сервер. Может быть только красным и не модифицироваться. Это можно сделать только через исходники проекта. Это хорошо, потому что в противном случае люди начнут редактировать вики-страницы, которые затем будут время от времени заменяться, потому что создается новая сборка / выпуск.
person
Verhagen
schedule
08.02.2010
