有没有办法从 javadoc 生成 confluence wiki 页面?

发布于 2024-08-02 11:44:42 字数 179 浏览 10 评论 0原文

我想将我正在从事的项目的文档放在 confluence wiki 上,并且我想从 javadocs 自动生成一些文档。是否有一个 confluence 插件可以让这变得简单(在初步搜索中没有看到),或者有没有人编写脚本来基于 javadocs 将 wiki 页面发布到 confluence?蚂蚁任务可能很酷,然后我可以将 wiki 作为目标。

I'd like to put documentation on a confluence wiki for a project I'm working on, and I want to automatically generate some of the documentation from javadocs. Is there a plugin for confluence that makes this easy (did not see in preliminary search), alternatively has anyone written scripts to post wiki pages to confluence based on javadocs? An ant task might be cool, then I could have the wiki as a target.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(3

樱娆 2024-08-09 11:44:42

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

接下来我们有一个 Wiki 系统,位于每个人都可以编写各种内容,在大多数 wiki 中很容易进行外部引用(到 Apache Web 服务器、项目文档/javadoc 页面)

。通过 ant / maven / 等生成并自动上传到某些网络服务器 只能是红色的并且不能修改 这只能通过项目源来完成,否则人们会开始编辑维基页面。 ,然后时不时地被替换,因为创建了新的构建/发布。

Why would you upload javadoc into an editing system? This sounds rater odd. We created a apache server on which the project documentation is uploaded (which is created form Java as javadoc, and from some project documentation (which we also store in the project (inside SCM)).

Next to that we have a Wiki system, in which everyone can write all kind of stuff. It is easy in most wiki to make a external reference (to the Apache web-server, project documentation / javadoc pages).

The good thing about this is, that the project documentation can be re-generated through ant / maven / etc. and automaticly uploaded to some web-server. There is can only be red and not modified. That can only be done through the project sources. Which is good, because otherwise people start to edit the wiki pages, which then get replaced now and then, because a new build / release is created.

墨离汐 2024-08-09 11:44:42

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

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

如果您只有一个 Confluence 服务器(或者 Confluence 服务器是文档的主要位置)来托管您的文档,您可能希望将 javadoc 添加到 confluence 中……以前也发生过这种情况。

Confluence JavaDocs Macros is a plugin that will generate wiki pages from javadocs. The downside is that a zip archive must be made of the javadocs and placed on the first page of a space, and multiple javadocs cannot co-exist in the same space.

The plugin is also not compatible with every version of Confluence.

And you might want to add javadocs to confluence if you only had a confluence server (or the confluence server is the primary place for documentation) to host your documentation... It has happened before.

半枫 2024-08-09 11:44:42

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

Docs 还提供了 REST 接口,以便自动化发布过程。因此,发布 JavaDocs 可以成为持续集成过程的一部分。您可以在这里找到技术文档和示例代码:https://ricebean.net/confluence-docs< /a>

You can use the Docs Plugin: https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin. This plugin enables you to upload and publish your JavaDocs and other HTML and JavaScript based content in Confluence.

Docs provides also a REST Interface in order to automate the publishing process. So, publishing the JavaDocs can become part of the Continuous Integartion Process. A technical documentation as well as a sample code can you find here: https://ricebean.net/confluence-docs

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文