是否存在用于编辑 doxygen 评论的“wiki”？ [关闭]

我正在开发一个相当大的开源 RTS 游戏引擎（Spring http://springrts.com/）。我最近添加了一堆可由 Lua 调用的新 C++ 函数，我想知道如何最好地记录它们，同时也刺激人们编写/更新文档a lot现有的 Lua 调用。

所以我想如果我最初可以将文档编写为 C++ 函数附近的 doxygen 注释，这可能会很好 - 这很容易，因为函数体显然准确地定义了函数的功能。不过，我希望使用该引擎的游戏开发人员能够改进文档，他们通常对 git（我们使用的 VCS）或 C++ 知之甚少。

因此，如果有一种方法可以从 C++ 文件自动生成 apidocs，同时也有一个类似 wiki 的 Web 界面以允许更广泛的受众更新评论、添加示例等，那就太理想了。

所以我想知道，是否存在一个 Web 工具，它集成了 doxygen 样式格式、类似 wiki 的注释编辑（最好不允许编辑源文件的任何其他部分）和 git？ （将通过Web界面更改的注释提交到特殊分支）

然后，我们开发人员可以时不时地合并这个分支，以将改进添加到 master 分支，同时开发人员对文档的任何改进都将最终出现在这个 Web 工具上，只需将 master 分支合并到这个特殊的分支中即可。分支。

我还没有找到任何东西，怀疑这个特定的东西是否存在，所以欢迎任何建议！

这确实是一个非常酷的想法，几年前我也非常需要类似的东西。不幸的是，至少在当时，我找不到类似的东西。今天在 sourceforge 和 freshmeat 上快速搜索也没有找到任何相关内容。

但我同意这样一个用户贡献文档的 wiki 前端将非常有用，我知道 Lua 社区最近也在讨论类似的事情（参见this http://lua-users.org/wiki/LuaSource).

那么，也许我们可以确定要求，以便提出基本的工作草案/原型？

希望这能让我们启动这样一个具有最少功能集的项目，然后将其作为开源项目（例如在 sourceforge 上）发布到野外，以便其他用户可以为其做出贡献。

理想情况下，人们可以使用统一的补丁来应用以这种方式贡献的更改。此外，将修改限制为仅添加/编辑注释可能是有意义的，而不是允许任意修改文本，这可能可以通过使用简单的正则表达式来实现。

也许，人们可以通过修改现有的（已建立的）wiki 软件（例如 mediawiki）来实现类似的功能。或者最好是已经使用 git 作为存储目的后端的东西。然后，主要需要满足那些 Doxygen 风格的注释，并在其之上提供一个简单的界面。

再想一想，DoxyGen 本身已经提供了对生成 HTML 文档的支持，因此从这个角度来看，如何扩展 DoxyGen 可能实际上很有趣，以便它与这样一个脚本化后端很好地集成，从而可以轻松地嵌入式源代码文档的定制。

这可能主要归结为使用 doxygen 提供独立脚本（例如，在 python、php 或 perl 中），然后可以选择将表单嵌入到自动创建的 HTML 文档中，以便可以通过浏览器将文档修复/增强发送到相应的脚本，这反过来会将任何修改写回相应的分支。

从长远来看，如果这样的脚本能够支持不同类型的后端（CVS、SVN 或 git），或者至少能够足够通用地实现，以便轻松扩展，那就太酷了。

因此，如果我们能拿出一个好的设计，这样的修改甚至有可能被普遍接受为对 doxygen 本身的贡献，这也将为整个事情带来更多的曝光度和动力。

即使这个想法没有直接落实到一个真实的项目中，看看有多少其他用户实际上喜欢这个想法也会很有趣，这样它就可能在 doxygen 问题跟踪器中被提及（https://github.com/doxygen/doxygen/issues/new https://github.com/doxygen/doxygen/issues/new).

编辑：您可能还想查看this http://morch.com/content/documentation-git-and-mediawiki文章标题为“文档、Git 和 MediaWiki” http://morch.com/content/documentation-git-and-mediawiki.