如何链接到 doxygen 中的植物图？

Question

我想在我的 *.dox 文档中添加一些 UML 图，满足以下要求：

• 我想包含纯 PlantUML 文档，其中不包含 doxygen 标记。
• 我希望它作为最终文档中图像的链接，而不是直接在主页上。

我怎样才能实现这个目标？

Answer 1

我相信这目前是不可能的，没有类似于@dotfile、@mscfile 或@diafile 的命令可以对 dot、msc 或 dia 源文件执行此操作。但是，如果您想在文档的不同页面中重用相同的图表，您可以让 doxygen 从代码中生成一个 png 文件，并且只包含该 png 文件：

\startuml [{file}] ["caption"] [<sizeindication>=<size>]

e.g.:
@startuml{myimage.png} "Image Caption" width=5cm

我没有尝试过这个，但是这样你可以解决这个问题，你可以在一个包含 doxygen 注释的 .h、.dox 或 .txt 文件中创建一个额外的页面，你可以在其中放置所有图表。来自这个文件doxygen 生成 png 文件。您可以使用 @image 命令嵌入的那些 png 文件。

Answer 2

要达到第一个要求，请尝试使用Plantuml preprocessing。像这样：

  /**
   * @startuml
   * !include my_diagram.txt!0
   * @enduml
   */

据我所知，目前 Doxygen 不支持第二个要求。