[Ubuntu]使用Doxygen生成 doxygen文档 并支持UML图的显示
前言
本人在软件开发过程中,有过在ubuntu下使用doxygen生成doxygen文档,并且其中一些源文件中包含了UML语法的经历, 在此总结一下。
/// \startuml
/// participant "Platform" as pal
/// participant "Generic" as svc
///
/// pal -> svc : <start svc>
/// activate svc
///
/// svc -> pal : register_state
/// pal -> svc : powering_up
///
/// note right svc
/// Action based on power state or meta data
/// end note
///
/// pal -> svc : powered
/// note right svc
/// Action based on power state or meta data
/// end note
/// \enduml
安装工具
要在生成的doxygen文档里正常显示UML图,需安装的工具有doxygen,plantuml。另外,为了支持plantuml的local render,需要安装Java-JDK和Graphviz