为内置帮助系统(QtHelp)生成HTML帮助的工具和方法?

时间:2010-02-21 21:15:18

标签: html documentation documentation-generation

我正在将基于QtHelp的内置帮助系统实现到我的应用程序中。由于QtHelp基于Qt的帮助集合文件,我需要生成一组HTML页面。

由于我不会单独编写文档(我的一些同事也会编写),我正在寻找生成这些文件的最佳方法。

我们在内部使用Wiki,我知道文档应该用某种标记语言编写,而不是给所有作者一个WYSIWYG HTML编辑器。

所以我的问题是,是否有工具可以帮助生成可以作为一组HTML文件导出的文档的过程,也可能作为PDF文件导出?。

提前致谢!

更新

我已经在使用Doxygen进行C ++文档生成了。但我并不是在寻找一个API文档生成器,而是像LaTeX这样的东西,它允许你像标记文档一样格式化文档内容(很像Wiki)。

2 个答案:

答案 0 :(得分:0)

如果您使用JavaScript编写应用程序,可能希望查看JSDoc 对于其他语言,Doxygen也是一个不错的选择。 http://www.doxygen.nl/
Doxygen可以输出HTML和PDF格式=)

有关文档生成器的更全面列表,Wikipedia和Google是您的朋友。 http://en.wikipedia.org/wiki/Comparison_of_documentation_generators

祝你好运

修改
好吧,Thread海报宣布他已经使用了Doxygen。但是,维基百科页面仍然存在,我想

我可能会问您正在使用哪种语言?

答案 1 :(得分:0)

我讨厌回答自己的问题,但我们最终决定选择LaTeX。

过去我们使用维基(MediaWiki和DokuWiki)作为文档,但是只要您想以格式化的格式(例如PDF指南)打印或发送文档,就会出现问题。

与Wiki标记语言相比,LaTeX并不复杂,但产生了漂亮的PDF文件,还有一系列LaTeX到HTML编译器,它们可以生成包含图形,目录和可点击链接的体面HTML文档和部分。