如何链接到doxygen中的plantuml图?

时间:2017-01-13 11:06:16

标签: doxygen

我想在我的* .dox文档中添加一些UML图表,满足这些要求:

  • 我想包含普通的PlantUML文档,其中没有doxygen标签。
  • 我想把它作为我最终文档中图像的链接,而不是直接在主页面上。

我如何实现这一目标?

2 个答案:

答案 0 :(得分:2)

我认为目前无法做到这一点,没有类似于@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文件。

答案 1 :(得分:0)

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

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

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