使用Doxygen绘制控制理论框图

Question

我正在研究自动化领域的C ++项目，我想开始记录。我决定选择Doxygen。但是，除了记录特定的数据字段和绘制类层次结构UML图之外，我还想用这样的框图来记录几种方法的功能：

有哪些解决方案？

我熟悉LaTeX。我读过Doxygen对LaTeX有一些支持，但我不知道这有多远。是否可以在Doxygen中使用任何LaTeX包？你会推荐哪些特定包装，你能提供一些简单的例子吗？

我也愿意接受与Doxygen不同的建议。

Answer 1

如果仅仅是获取控制系统结构，变量等，您可以在其他地方生成图表（例如Dia，XFig或Inkscape，如果您想使用开源工具）并通过图像将它们嵌入到Doxygen文档中代码中的关键字：

/*!
.. Doxygen doc here..
\image html Data_Model.png "Figure 1: UML Diagram of the Data Source and Data Model Relationships"
*/

要做到这一点，你需要在 Doxyfile 文件中告诉Doxygen在哪里找到图像，并将图像相对于你的doxygen路径放置（在这种情况下是DOCROOT / images）：

# The IMAGE_PATH tag can be used to specify one or more files or 
# directories that contain image that are included in the documentation (see 
# the \image command).

IMAGE_PATH             = images

使用乳胶扩展或其他语言驱动的图形标记从Doxygen doc中生成图形确实无法证明学习语言的开销，使工具链配置和对齐。另一方面，如果你有一些工具已经自动生成图形（从你的代码或配置文件），从Makefile中运行工具应该是轻而易举的，让它生成图像并嵌入图像你的doxygen doc通过image关键字。