XUbuntu22.04之doxygen将ffmpeg源码生成调用树(一百六十三)

公众号：Android系统攻城狮

简介： CSDN博客专家，专注Android/Linux系统，分享多mic语音方案、音视频、编解码等技术，与大家一起成长！

优质专栏：Audio工程师进阶系列【原创干货持续更新中……】🚀

人生格言： 人生从来没有捷径，只有行动才是治疗恐惧和懒惰的唯一良药.

1.安装软件

# udo apt-get install graphviz
# sudo apt-get install doxygen
# sudo apt-get install doxygen-gui

2.GUI配置

# doxywizard

3.命令配置

# doxygen -g <config-file>

其中<config-file>是配置文件的名称。如果省略文件名，将创建一个名为Doxyfile的文件。如果名称为<config-file>的文件已存在，则doxygen会在生成配置模板之前将其重命名为<config-file> .bak。如果您使用-（即减号）作为文件名，那么doxygen将尝试从标准输入（stdin）读取配置文件，这对脚本编写非常有用。

修改完Doxyfile后，生成文档

# doxygen
#会在OUTPUT_DIRECTORY所指定的路径下生成html文件夹和latex文件夹。点击index.html，在浏览器
#就会看到生成的文档

# 项目名称, 将显示为标题
PROJECT_NAME           = "simple"

PROJECT_NUMBER         =  "v1.0.0" #文档版本号
PROJECT_BRIEF          = "doxygen brief" #一行描述，说明文档的目的
OUTPUT_DIRECTORY       =   #指定生成文档的存储路径，缺省值使当前路径

OUTPUT_LANGUAGE        = Chinese  #生成简体中文

代码目录
INPUT                  = ../

#对头文件和源文件的文档化信息生成程序文档
FILE_PATTERNS          = *.h \ 
                         *.c \
                         *.cpp
                         
#指定应从输入源文件中排除的文件和/或目录                        
EXCLUDE                =   

#对于使用 typedef 定义的结构体、枚举、联合等数据类型，只按照 typedef 定义的类型名进行文档化
TYPEDEF_HIDES_STRUCT   = YES

# 在 C++ 程序文档中，该值可以设置为 NO，而在 C 程序文档中，由于 C 语言没有所谓的域/名字
# 空间这样的概念，所以此处设置为 YES
HIDE_SCOPE_NAMES       = YES

# 让 doxygen 静悄悄地为你生成文档，只有出现警告或错误时，才在终端输出提示信息
QUIET                  = YES

# 允许程序文档中显示本文档化的函数相互调用关系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES

# 生成 latex 格式的程序文档
GENERATE_LATEX         = YES 

# 在程序文档中允许以图例形式显示函数调用关系，前提是你已经安装了 graphviz 软件包
HAVE_DOT               = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES


PDF_HYPERLINKS         = YES #生成PDF文档

USE_PDFLATEX           = YES #使用LaTeX来生成PDF文档


EXTRACT_ALL            = YES

#这会在HTML文档中，添加一个侧边栏，并以树状结构显示包、类、接口等的关系
GENERATE_TREEVIEW      = YES



#如果是制作的C程序文档，该选项必须设置成YES，否则默认为C++
OPTIMIZE_OUTPUT_FOR_C  = YES 

# 递归扫描
RECURSIVE              = YES

###排除搜索选项
EXCLUDE_PATTERNS       = */tests/*
EXCLUDE_PATTERNS      += */docs/*
EXCLUDE_PATTERNS      += */out/*
EXCLUDE_PATTERNS      += */doxy/*
EXCLUDE_PATTERNS      += */target/*
EXCLUDE_PATTERNS      += */prebuilts/*

# 文档主页使用 READMD.md
USE_MDFILE_AS_MAINPAGE = README.md
# 使用 mathjax 显示公式
USE_MATHJAX            = YES


DOXYFILE_ENCODING      = UTF-8    #doxygen文件的编码格式


# 输出位置，我希望输出到 target/doc 目录下
OUTPUT_DIRECTORY       = target/doc

4.生成文档

# 生成 html 和 latex 源文件
doxygen 
# 编译 latex 文件生成 pdf
cd target/doc/latex
make

更多原创,欢迎关注：Android系统攻城狮