embedded-framework/doc/doxygen_user_guide.md
2024-04-29 09:15:28 +08:00

21 lines
546 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 1. Linux嵌入式项目使用Doxygen生成API文档
## 1.1. Doxygen简介
  Doxygen是一个开源的文档生成工具可以用来生成项目源代码的API文档。
## 1.2. Doxygen安装
  Doxygen安装非常简单直接在官网下载最新版本即可。
```
$ sudo apt-get install doxygen
```
## 1.3. 安装Graphviz
  Doxygen本身不直接支持画图功能但它可以生成DOT格式的图形描述文件然后使用Graphviz工具进行渲染。
```
$ sudo apt-get install graphviz
```