oceanbase / miniob

MiniOB is a compact database that assists developers in understanding the fundamental workings of a database.
https://oceanbase.github.io/miniob/
Mulan Permissive Software License, Version 2
2.86k stars 1.01k forks source link

doxygen优化 首页说明单独写在一个md文档 #349

Closed DylanGuo916 closed 2 months ago

DylanGuo916 commented 2 months ago

What problem were solved in this pull request?

Issue Number: close #252

Problem:当前doxy文档中首页说明是放在main.cpp代码文件中的,这样写并不好,单独写在一个文本文档中更好一点。

What is changed and how it works?

修改doxy配置文件 mainpage 单独写成一个 md 文件

Other information

CLAassistant commented 2 months ago

CLA assistant check
All committers have signed the CLA.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

:exclamation: No coverage uploaded for pull request base (main@34d0b3c). Click here to learn what that means. Report is 2 commits behind head on main.

:exclamation: Current head 9a67cf5 differs from pull request most recent head e3bb2db. Consider uploading reports for the commit e3bb2db to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #349 +/- ## ======================================= Coverage ? 36.97% ======================================= Files ? 101 Lines ? 7272 Branches ? 0 ======================================= Hits ? 2689 Misses ? 4583 Partials ? 0 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.