组合Docbook和Doxygen文档类型。
组合Docbook和Doxygen文档类型。
提问于 2013-03-19 19:14:00
我正在为我们的软件库编写新的文档，我想知道如何将我认为应该用DocBook编写的通用文档与基于DocBook的应用编程接口参考结合起来。
Doxygen部分已经存在，所以我更喜欢保留它，但使用DocBook只是一个想法，我对任何想法都持开放态度。用Doxygen编写整个文档是可能的，但在我看来这不是最好的方法。
谢谢!
回答 1
Stack Overflow用户
回答已采纳
发布于 2014-02-10 19:14:50
我建议你重新考虑采用全氧的方式。尽管使用Doxygen编写详细的文档一开始看起来很麻烦，但从长远来看，保持两个文档的一致性将是更多的工作。除了通过组合两者的输出产品而增加的工作负载之外。
source使您可以将Markdown文件作为页面包含到您的文档中(参见手册的this section )，并外部化精心设计的文档，以避免过度放大您的源文件(参见手册的this other section )。
我还应该补充说，我以前没有使用Docbook的第一手经验，所以这可能会让我有点偏向Doxygen。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/15497914
复制相关文章
相似问题