将OpenOffice/Libreoffice与Doxygen结果结合起来进行代码文档? 问题
我们目前希望通过重新使用以前的OpenOffice结果,从手动迁移到自动C代码文档 背景 在过去10年中,我们手动生成了许多OpenOffice(*.odt)文件,包括类似prosa的体系结构、“它是如何工作的”、图形和详细的API描述。因此,我们每个产品都有一个单独的文档(为我们的客户导出为*.pdf) 我们现在将C代码更改为使用与Doxygen兼容的格式和关键字,从而生成格式良好的文档(HTML+CHM,到目前为止还没有PDF)。但这当然只包括详细的API。目标仍然是生成单个结果文件,包括prosa和graphics 考虑将OpenOffice和Doxygen的结果结合起来,我们想知道如何以及朝着哪个方向进行:将OpenOffice/Libreoffice与Doxygen结果结合起来进行代码文档? 问题,c,doxygen,C,Doxygen,我们目前希望通过重新使用以前的OpenOffice结果,从手动迁移到自动C代码文档 背景 在过去10年中,我们手动生成了许多OpenOffice(*.odt)文件,包括类似prosa的体系结构、“它是如何工作的”、图形和详细的API描述。因此,我们每个产品都有一个单独的文档(为我们的客户导出为*.pdf) 我们现在将C代码更改为使用与Doxygen兼容的格式和关键字,从而生成格式良好的文档(HTML+CHM,到目前为止还没有PDF)。但这当然只包括详细的API。目标仍然是生成单个结果文件,包括p
从旧的文档样式迁移到等效的单个文档文件(包括Doxygen结果)最有效的方法是什么?在花费太长时间试图用Doxygen构建完整的文档后,我最近已经转换到Sphinx+Breathe+Doxygen。我发现多个工具增加的复杂性可以通过使用可用的文档来抵消 Doxygen用于您的API文档,保持其内联有助于鼓励API使用代码进行更新 用于系统文档、体系结构描述等。。Sphinx是一个经过重组的基于文本的文档系统,您需要转换现有的ODT文档 是一座桥梁,允许您将Doxygen文档带入Sphinx。Doxygen被编译成XML,然后提取XML并将其推送到已编译的Sphinx文档中
斯芬克斯与呼吸可能还有其他选择,但我强烈推荐这样的拆分。它允许Doxygen使用其强大的API,并允许您在一个您不必每天都要使用的工具中进行更高级别的系统文档编制。浏览Sphinx(+Breath)后,我看到了Sphinx的优点(它生成了所有这些很好的示例)。但是这个解决方案意味着从OO=>Sphinx(而不是OO=>Doxygen)过渡,并且需要一个额外的工具链(Breath),这会增加复杂性和依赖性——我不是这个问题的朋友。但我们会分析它来决定,这对我们来说是否是个好办法。感谢您为上述问题提供此备选方案!拉尔夫