Skip to content

Commit

Permalink
doxygen优化 首页说明单独写在一个md文档 (#349)
Browse files Browse the repository at this point in the history
### 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
  • Loading branch information
DylanGuo916 authored Mar 7, 2024
1 parent 95d941d commit 6b67c11
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -1154,7 +1154,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = src/observer/mainpage.md

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down
11 changes: 0 additions & 11 deletions src/observer/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,6 @@ See the Mulan PSL v2 for more details. */
* Author: Longda Feng
*/

/**
* @mainpage MiniOB
*
* MiniOB 是 OceanBase 与华中科技大学联合开发的、面向"零"基础同学的数据库入门学习项目。
*
* MiniOB 设计的目标是面向在校学生、数据库从业者、爱好者,或者对基础技术有兴趣的爱好者, 整体代码量少,易于上手并学习,
* 是一个系统性的数据库学习项目。miniob 设置了一系列由浅入深的题目,以帮助同学们"零"基础入门,
* 让同学们快速了解数据库并深入学习数据库内核,期望通过相关训练之后,能够熟练掌握数据库内核模块的功能与协同关系,
* 并能够在使用数据库时,设计出高效的 SQL 。miniob 为了更好的学习数据库实现原理,
* 对诸多模块都做了简化,比如不考虑并发操作, 安全特性, 复杂的事物管理等功能。
*/

#include <iostream>
#include <netinet/in.h>
Expand Down
5 changes: 5 additions & 0 deletions src/observer/mainpage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# MiniOB

MiniOB 是 OceanBase 与华中科技大学联合开发的、面向"零"基础同学的数据库入门学习项目。

MiniOB 设计的目标是面向在校学生、数据库从业者、爱好者,或者对基础技术有兴趣的爱好者, 整体代码量少,易于上手并学习, 是一个系统性的数据库学习项目。miniob 设置了一系列由浅入深的题目,以帮助同学们"零"基础入门, 让同学们快速了解数据库并深入学习数据库内核,期望通过相关训练之后,能够熟练掌握数据库内核模块的功能与协同关系, 并能够在使用数据库时,设计出高效的 SQL 。miniob 为了更好的学习数据库实现原理, 对诸多模块都做了简化,比如不考虑并发操作, 安全特性, 复杂的事物管理等功能。

0 comments on commit 6b67c11

Please sign in to comment.