有没有办法从javadocs生成汇合维基页面?

时间:2009-08-19 14:55:23

标签: wiki javadoc confluence

我想将文档放在一个我正在处理的项目的汇总维基上,我想从javadocs自动生成一些文档。有没有一个汇合的插件,这使得这很容易(在初步搜索中没有看到),或者有人编写脚本来发布基于javadocs的wiki页面融合?蚂蚁任务可能很酷,然后我可以将wiki作为目标。

3 个答案:

答案 0 :(得分:2)

Confluence JavaDocs宏是一个从javadocs生成wiki页面的插件。缺点是zip存档必须由javadoc构成并放置在空间的第一页上,并且多个javadoc不能在同一空间中共存。

该插件也与Confluence的每个版本都不兼容。

如果您只有一个confluence服务器(或者汇流服务器是文档的主要位置)来托管您的文档,那么您可能希望将javadoc添加到汇合中......它已经发生过。

答案 1 :(得分:1)

您可以使用文档插件:https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin。通过此插件,您可以在Confluence中上传和发布JavaDocs以及其他基于HTML和JavaScript的内容。

Docs还提供REST接口以自动化发布过程。因此,发布JavaDocs可以成为Continuous Integartion Process的一部分。您可以在此处找到技术文档和示例代码:https://ricebean.net/confluence-docs

答案 2 :(得分:0)

为什么要将javadoc上传到编辑系统?这听起来很奇怪。我们创建了一个上传项目文档的apache服务器(它是从Java创建的javadoc,以及一些项目文档(我们也存储在项目中(在SCM中))。

接下来我们有一个Wiki系统,每个人都可以编写所有类型的东西。在大多数wiki中很容易做出外部引用(对于Apache Web服务器,项目文档/ javadoc页面)。

关于这一点的好处是,可以通过ant / maven /等重新生成项目文档,并自动上传到某个Web服务器。只能是红色而不是修改。这只能通过项目来源完成。哪个好,因为否则人们开始编辑维基页面,然后立即被替换,因为创建了新的构建/发布。