如何将phpDoc导入Confluence？

Question

如何将phpDoc导入Confluence？

phpdocconfluence

4

我正在寻找一种适当的方式，将项目中的phpDoc注释用于生成开发人员文档，以便在Confluence 4.1.4中使用。

- DrSat

3个回答

2

我正在寻找相同的解决方案。我最接近的解决方案是使用html2wiki，它具有适用于Confluence的方言。我创建了一个PHP脚本，递归遍历我的api目录，并使用此html2wiki程序处理每个html页面。不幸的是，它不能完美地格式化标记并留下不需要的HTML痕迹。

我的下一步尝试是尝试调整方言以尝试解决格式不良的问题。 http://search.cpan.org/~diberri/HTML-WikiConverter-0.51/bin/html2wiki

- Brett

1

最近，我一直在研究编写自己的转换器，它可以扩展phpDocumentor转换器类，以便我可以直接将数据转换为Confluence标记。但是由于我所能依据的唯一示例是phpdoc附带的HTML、PDF、XML和CHM，因此在做这件事时遇到了一些困难。问题在于所有这些示例都生成了所有类等的索引，而我需要的只是为每个类文件创建单个的Confluence维基页面。如果您在这方面取得了任何进展，请告诉我。谢谢。 - Brett

1

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

Docs还提供了REST接口，以便自动化发布过程。因此，PHPDocs的发布可以成为持续集成过程的一部分。您可以在这里找到技术文档以及示例代码：https://bitbucket.org/meixxi/docs-plugin/wiki/Home

- meixxi

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- danger4242 · Accepted Answer

我一直在考虑的一种方法是将我的HTML输出（类似于phpDoc）部署为Confluence实例中Tomcat的第二个Web应用程序，然后将该文档iFrame到Confluence页面中。它不与Confluence的搜索/索引或标记集成，但它应该与我们设置的Crowd身份验证方案相容。我认为我可以使用联合搜索工具在这两个Web应用程序之间进行搜索。