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

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

但是我同意这样一个wiki前端到用户贡献的文档是非常有用的,我知道事实上类似的东西最近也在Lua社区中讨论过(参见 this

那么,也许我们可以确定需求,从而得出一个基本的工作草案/原型?

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

也许,可以通过修改现有(已建立的)wiki软件(如mediawiki)来实现类似的功能。或者最好是已经使用git作为后端进行存储的东西。然后,主要需要迎合那些Doxygen风格的评论,并在上面提供一个简单的界面。

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

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

从长远来看,如果这样一个脚本能够支持不同类型的后端(CVS、SVN或git),或者至少能够实现足够的通用性,从而易于扩展,那就太酷了。

因此,如果我们能想出一个好的设计,甚至有可能这样的修改会被普遍接受为对强氧本身的贡献,这也会给整个过程带来更多的曝光和动力。

https://github.com/doxygen/doxygen/issues/new ).

编辑:您可能还想签出 this 标题为 "Documentation, Git and MediaWiki"