未验证 提交 6d9a299a 编写于 作者: 羽飞's avatar 羽飞 提交者: GitHub

doxygen 文档 (#189)

### What problem were solved in this pull request?

Issue Number: close #188 

Problem:
利用doxygen将代码注释生成文档

### What is changed and how it works?
修改github action,增加doxygen生成文档,并gihtub pages部署发布

### Other information
上级 e772a91f
......@@ -32,9 +32,10 @@ jobs:
submodules: false
- name: Doxygen Action
run: mattnotmitt/doxygen-action@v1.9.5
working-directory: .
doxyfile-path: ./Doxyfile
uses: mattnotmitt/doxygen-action@v1.9.5
with:
working-directory: .
doxyfile-path: ./Doxyfile
- name: Setup Pages
uses: actions/configure-pages@v3
......
......@@ -3,6 +3,7 @@
./deps/googletest
./deps/jsoncpp
./deps/benchmark
./docs/doxy/
build/*
build_*
cmake-build-*/*
......
......@@ -16,6 +16,7 @@ miniob 设计的目标是面向在校学生、数据库从业者、爱好者,
4. [开发环境搭建(本地调试, 适用 Linux 和 Mac)](docs/how_to_dev_miniob_by_vscode.md)
5. [开发环境搭建(远程调试, 适用于 Window, Linux 和 Mac)](docs/how_to_dev_in_docker_container_by_vscode.md)
6. [miniob 词法语法解析开发与测试](docs/miniob-sql-parser.md)
7. [doxygen 代码文档](docs/doxy/html/index.html)
更多的文档, 可以参考 docs 目录下的文档, 为了帮助大家更好的学习数据库基础知识, OceanBase 社区提供了一系列教程, 建议学习:
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册