如何在Doxygen中包含.iuml路径来生成PlantUML图

时间:2014-05-15 18:09:59

标签: documentation uml doxygen class-diagram plantuml

我正在使用Doxygen处理组件的文档,我希望在文本之间包含UML图表。

我知道如何做大部分工作,因为我只需要将.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文件(相对路径)我作为include指令的参数。

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

我能帮忙吗?

2 个答案:

答案 0 :(得分: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 Addin提出了类似的要求,这里有效。

答案 1 :(得分:0)

真实答案

使用Doxygen向导的DOT面板中显示的PLANTUML_INCLUDE_PATH = ./someRelativeDir配置。

include路径是相对于你的Doxygen配置,即从中获取doxygen配置的起始目录。

红鲱鱼

我将这个答案的其余部分留在这里以防万一有人以前找到它。

错误地报告了一个错误,因为我需要新的老花镜而且没有注意到我路上的流浪角色。

这已解决为 a 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