如何在 Doxygen 中包含 .iuml 路径以生成 PlantUML 图答案

【问题标题】：How to include .iuml path to generate PlantUML diagram in Doxygen如何在 Doxygen 中包含 .iuml 路径以生成 PlantUML 图
【发布时间】：2014-07-04 08:10:22
【问题描述】：

我正在使用 Doxygen 编写组件的文档，我想在文本之间包含 UMLdiagrams。

我知道如何做大部分事情，因为我只需将.tuml 源复制到我的.dox 文件中并运行doxygen。但是，我的一个图表是包含其他 .iuml 文件的类图，如 PlantUML site 中所述。

所以，基本上，我愿意：

@mainpage main_page MyDoxygen
\
...
\
@startuml
\
!include iuml_files/Class01.iuml
!include iuml_files/Class02.iuml
\
MainClass <|-- Class01
MainClass <|-- Class02
\
@enduml

长话短说，我不知道如何让 Doxygen 理解它必须在我作为包含指令的参数提供的目录（相对路径）中查找 .iuml 文件。

如果我对我需要什么不够清楚，请告诉我，我会尽量让它更清楚。

我能得到一些帮助吗？

【问题讨论】：

标签： documentation uml doxygen class-diagram plantuml

【解决方案1】：

我遇到了类似的问题（我拥有用于植物的 Word 插件）

您可以在命令行中指定 java 属性“plantuml.include.path”： java -Dplantuml.include.path="c:/mydir" -jar plantuml.jar atest1.txt （见http://plantuml.sourceforge.net/preprocessing.html）

我希望当您修改用于调用 Plantuml 的批处理文件时它会起作用 http://plantuml.sourceforge.net/doxygen.html

我对 Plantuml 的 Word 插件也有类似的要求，但它在这里奏效了。

【讨论】：

嗨@Adriaan！我相信它比这更简单。在我发布这个问题几分钟后，我发现我犯了一个愚蠢的错误：我需要的文件并不完全在我描述的那个路径中。将它们放在正确的目录中可以使一切按预期工作。我已经制定了一个答案，要求人们简单地忽略我的问题，因为我已经找到了解决方案，但我发现我只能在 6 小时后发布我自己的问题的答案......结果我忘记了。菜鸟用户在这里。感谢您尝试提供帮助！ P.S.：甚至不能“投票”你的回复。我还没有 15 个代表。

【解决方案2】：

真正的答案

使用PLANTUML_INCLUDE_PATH = ./someRelativeDir 配置，在 Doxygen 向导的 DOT 面板中可见。

包含路径与您的 Doxygen 配置相关，即获取 doxygen 配置的起始目录。

红鲱鱼

我将把这个答案的其余部分留在这里，以防之前有人发现它。

我错误地报告了一个错误，因为我需要新的老花镜并且没有注意到我的路径中有一个流浪字符。

这被解决为不是Doxygen bug

对于任何感兴趣的人，这就是我所看到的。

Running PlantUML on generated file /Users/andydent/dev/touchgramdesign/doxygeneratedTG4IM/html/inline_umlgraph_1.pu
Preprocessor Error: Cannot include /Users/andydent/dev/touchgramdesign/doxygeneratedTG4IM/html/handDrawnStyle.iuml
Error line 2 in file: /Users/andydent/dev/touchgramdesign/doxygeneratedTG4IM/html/inline_umlgraph_1.pu
Some diagram description contains errors
error: Problems running PlantUML. Verify that the command 'java -jar "/Library/Java/Extensions/plantuml.jar" -h' works from the command line. Exit code: 1

这是使用配置设置

PLANTUML_INCLUDE_PATH = ./iumltToCopy

比我（当时）更敏锐的眼睛注意到路径中的多余字符 iuml t ToCopy

【讨论】：