How to use Trace2UML together with Doxygen

最新推荐文章于 2025-12-19 17:23:40 发布

翻译最新推荐文章于 2025-12-19 17:23:40 发布 · 1.2k 阅读

文章标签：

#uml #documentation #class #charts #insert

uml 专栏收录该内容

8 篇文章

订阅专栏

本文介绍如何结合使用Trace2UML和Doxygen来为文档生成序列图。从Doxygen 1.5.3版本开始，支持在文档中插入序列图，并且可以使用mscgen或兼容的Trace2UML进行描述。文章详细说明了配置过程及语法示例。

部署运行你感兴趣的模型镜像

How to use Trace2UML together with Doxygen

From Doxygen version 1.5.3 doxygen supports sequence charts inside thedocumentation. Original doxygen works together with mscgen(a tool similar to Trace2UML).

But because Trace2UML is now call compatible with mscgen, you can useTrace2UML instead. The only thing you have to do by hand, is to RENAME"Trace2UML.exe" into "mscgen.exe" (or do a symbolic link, onLinux). This is because Doxygen has the tool name hard coded in its binary (maybethis will change one day ;-)

So follow the Doxygen documentation to insert a sequence diagram with thecommands "\msc" and "\endmsc" but use Trace2UML syntax todescribe the sequence diagram:

....

\mcs

         ~ (!) Class1
         ~ ==> Class1 Create()
    Class1 (!) Class2
    Class1 ==> Class2 Init()
    Class1 <== Class2 0
         ~ <== Class1 0

\endmsc

...