[Ubuntu]使用Doxygen生成 doxygen文档 并支持UML图的显示

[Ubuntu]使用Doxygen生成 doxygen文档 并支持UML图的显示

前言安装工具生成doxygen配置文件Doxyfile并修改生成doxygen文档查看doxygen文档

前言

本人在软件开发过程中，有过在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 1。 安装顺序： Doxygen -> Graphviz -> Java JDK -> PlantUML 安装方法：

安装Doxygen 及 Graphviz sudo apt install doxygen graphviz mscgen 安装Java JDK-8 Java 有两个版本，下面命令安装的是open java sudo apt-get update && sudo apt-get install openjdk-8-jdk

运行java -version检查Java-JDK安装是否成功。 3. 安装PlantUML

sudo apt-get install plantuml

生成doxygen配置文件Doxyfile并修改

在需要生成doxygen文档的目录下，执行命令 2：

doxygen -s -g

为了使用PlantUML工具来解析UML语法并支持UML 图的显示， 需要指定Doxyfile里的PLANTUML_JAR_PATH到plantuml.jar所在的路径：

生成doxygen文档

到有Doxyfile的目录下，执行命令：

doxygen Doxyfile

查看doxygen文档

可以使用浏览器打开doxygen/html/index.html

// 使用firefox 打开.html文件 $$ firefox doxygen/html/index.html