1 生成文档
- 系统为
Ubuntu 18.04.6 LTS
- git clone下载相关的vpp源码,比如
V20.01
- 执行如下命令,生成代码对应的文档到{$top}/build-root/docs/html目录
#在top目录执行命令,安装依赖
make bootstrap-doxygen#在top目录执行命令,生成文档
#如果执行失败,可能需要手动安装dot/doxygen工具,apt install dot doxygen
make doxygen#在top目录执行命令,删除文档后重新生成
#一般在top目录的build-root/docs里生成相关文档
make wipe-doxygen;make doxygen
2 文档内容的来源
- 生成的文档,根据代码里的注释,来生成
- 注释风格采用doxygen风格
- 新写的代码,采用类似风格将能自动生成文档
- https://blog.csdn.net/qq_43331089/article/details/127761842
- doxygen注释风格如下
/*** @brief 主函数* @details 程序唯一入口** @param argc 命令参数个数* @param argv 命令参数指针数组* @return @c 0 程序执行成功* @c 1 程序执行失败
*/
int main(int argc, char* argv[]){
}