如何在 doxygen 中 link 到 plantuml 图?
how to link to plantuml diagram in doxygen?
我想在我的 *.dox 文档中添加一些 UML 图,并满足以下要求:
- 我想包含纯 PlantUML 文档,其中没有 doxygen 标签。
- 我希望它作为 link 图像出现在我的最终文档中,而不是直接放在主页上。
我怎样才能实现这个目标?
我认为目前这是不可能的,没有类似于 @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 文件。
要实现第一个要求,请尝试使用 Plantuml preprocessing。像这样:
/**
* @startuml
* !include my_diagram.txt!0
* @enduml
*/
据我所知,目前 Doxygen 不支持第二个要求。
我想在我的 *.dox 文档中添加一些 UML 图,并满足以下要求:
- 我想包含纯 PlantUML 文档,其中没有 doxygen 标签。
- 我希望它作为 link 图像出现在我的最终文档中,而不是直接放在主页上。
我怎样才能实现这个目标?
我认为目前这是不可能的,没有类似于 @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 文件。
要实现第一个要求,请尝试使用 Plantuml preprocessing。像这样:
/**
* @startuml
* !include my_diagram.txt!0
* @enduml
*/
据我所知,目前 Doxygen 不支持第二个要求。