How to use Trace2UML together with Doxygen

来源:互联网 发布:淘宝页面两边怎么设置 编辑:程序博客网 时间:2024/05/16 17:39

How to use Trace2UML together with Doxygen

From Doxygen version 1.5.3 doxygen supports sequence charts inside thedocumentation. Original doxygen works together withmscgen(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

...

Than Doxygen will place the following  graphic into your documentation:


原创粉丝点击