Docs (oceanbase#201)

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

Issue Number: close oceanbase#191 

Problem:
doxy文档的首页没有描述

### What is changed and how it works?
增加首页描述信息，写在了main.cpp中

### Other information

Author: hnwyllmm

src/observer/main.cpp

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

src/observer/sql/executor/command_executor.h

@@ -18,7 +18,15 @@ See the Mulan PSL v2 for more details. */
 
 class SQLStageEvent;
 
+/**
+ * @defgroup Executor
+ * @brief 一些SQL语句不会生成对应的执行计划，直接使用Executor来执行，比如DDL语句
+ */
 
+/**
+ * @brief 执行器
+ * @ingroup Executor
+ */
 class CommandExecutor
 {
 public:

src/observer/sql/executor/create_index_executor.h

@@ -18,6 +18,11 @@ See the Mulan PSL v2 for more details. */
 
 class SQLStageEvent;
 
+/**
+ * @brief 创建索引的执行器
+ * @ingroup Executor
+ * @note 创建索引时不能做其它操作。MiniOB当前不完善，没有对一些并发做控制，包括schema的并发。
+ */
 class CreateIndexExecutor
 {
 public:

src/observer/sql/executor/create_table_executor.h

@@ -18,6 +18,10 @@ See the Mulan PSL v2 for more details. */
 
 class SQLStageEvent;
 
+/**
+ * @brief 创建表的执行器
+ * @ingroup Executor
+ */
 class CreateTableExecutor
 {
 public:

src/observer/sql/executor/desc_table_executor.h

@@ -18,6 +18,10 @@ See the Mulan PSL v2 for more details. */
 
 class SQLStageEvent;
 
+/**
+ * @brief 描述表的执行器
+ * @ingroup Executor
+ */
 class DescTableExecutor
 {
 public:

src/observer/sql/executor/help_executor.h

@@ -21,6 +21,10 @@ See the Mulan PSL v2 for more details. */
 #include "sql/executor/sql_result.h"
 #include "session/session.h"
 
+/**
+ * @brief Help语句执行器
+ * @ingroup Executor
+ */
 class HelpExecutor
 {
 public:

src/observer/sql/executor/show_tables_executor.h

@@ -22,6 +22,11 @@ See the Mulan PSL v2 for more details. */
 #include "session/session.h"
 #include "storage/db/db.h"
 
+/**
+ * @brief 显示所有表的执行器
+ * @ingroup Executor
+ * @note 与CreateIndex类似，不处理并发
+ */
 class ShowTablesExecutor
 {
 public:

src/observer/sql/executor/sql_result.h

@@ -22,6 +22,12 @@ See the Mulan PSL v2 for more details. */
 
 class Session;
 
+/**
+ * @brief SQL执行结果
+ * @details 如果当前SQL生成了执行计划，那么在返回客户端时，调用执行计划返回结果。
+ * 否则返回的结果就是当前SQL的执行结果，比如DDL语句，通过return_code和state_string来描述。
+ * 如果出现了一些错误，也可以通过return_code和state_string来获取信息。
+ */
 class SqlResult 
 {
 public:
@@ -63,9 +69,9 @@ class SqlResult
   RC next_tuple(Tuple *&tuple);
 
 private:
-  Session *session_ = nullptr;
-  std::unique_ptr<PhysicalOperator> operator_;
-  TupleSchema tuple_schema_;
+  Session *session_ = nullptr; ///< 当前所属会话
+  std::unique_ptr<PhysicalOperator> operator_;  ///< 执行计划
+  TupleSchema tuple_schema_;   ///< 返回的表头信息。可能有也可能没有
   RC return_code_ = RC::SUCCESS;
   std::string state_string_;
 };

src/observer/sql/executor/trx_begin_executor.h

@@ -22,6 +22,10 @@ See the Mulan PSL v2 for more details. */
 #include "session/session.h"
 #include "storage/trx/trx.h"
 
+/**
+ * @brief 事务开始语句的执行器
+ * @ingroup Executor
+ */
 class TrxBeginExecutor
 {
 public:

src/observer/sql/executor/trx_end_executor.h

@@ -22,6 +22,10 @@ See the Mulan PSL v2 for more details. */
 #include "storage/trx/trx.h"
 #include "sql/stmt/stmt.h"
 
+/**
+ * @brief 事务结束的执行器，可以是提交或回滚
+ * @ingroup Executor
+ */
 class TrxEndExecutor
 {
 public:

src/observer/sql/expr/expression.h

@@ -22,19 +22,29 @@ See the Mulan PSL v2 for more details. */
 
 class Tuple;
 
+/**
+ * @defgroup Expression
+ * @brief 表达式
+ */
+
+/**
+ * @brief 表达式类型
+ * @ingroup Expression
+ */
 enum class ExprType 
 {
   NONE,
-  FIELD,
-  VALUE,
-  CAST,
-  COMPARISON,
-  CONJUNCTION,
+  FIELD,        ///< 字段。在实际执行时，根据行数据内容提取对应字段的值
+  VALUE,        ///< 常量值
+  CAST,         ///< 需要做类型转换的表达式
+  COMPARISON,   ///< 需要做比较的表达式
+  CONJUNCTION,  ///< 多个表达式使用同一种关系(AND或OR)来联结
 };
 
 /**
- * 表达式的抽象描述
- * 在SQL的元素中，任何需要得出值的元素都可以使用表达式来描述
+ * @brief 表达式的抽象描述
+ * @ingroup Expression
+ * @details 在SQL的元素中，任何需要得出值的元素都可以使用表达式来描述
  * 比如获取某个字段的值、比较运算、类型转换
  * 当然还有一些当前没有实现的表达式，比如算术运算。
  *
@@ -49,22 +59,27 @@ class Expression
   virtual ~Expression() = default;
 
   /**
-   * 根据具体的tuple，来计算当前表达式的值
+   * @brief 根据具体的tuple，来计算当前表达式的值。tuple有可能是一个具体某个表的行数据
    */
   virtual RC get_value(const Tuple &tuple, TupleCell &cell) const = 0;
 
   /**
-   * 表达式的类型
+   * @brief 表达式的类型
    * 可以根据表达式类型来转换为具体的子类
    */
   virtual ExprType type() const = 0;
 
   /**
-   * 表达式值的类型
+   * @brief 表达式值的类型
+   * @details 一个表达式运算出结果后，只有一个值
    */
   virtual AttrType value_type() const = 0;
 };
 
+/**
+ * @brief 字段表达式
+ * @ingroup Expression
+ */
 class FieldExpr : public Expression 
 {
 public:
@@ -111,6 +126,10 @@ class FieldExpr : public Expression
   Field field_;
 };
 
+/**
+ * @brief 常量值表达式
+ * @ingroup Expression
+ */
 class ValueExpr : public Expression 
 {
 public:
@@ -166,6 +185,10 @@ class ValueExpr : public Expression
   TupleCell tuple_cell_;
 };
 
+/**
+ * @brief 类型转换表达式
+ * @ingroup Expression
+ */
 class CastExpr : public Expression 
 {
 public:
@@ -192,6 +215,10 @@ class CastExpr : public Expression
   AttrType cast_type_;
 };
 
+/**
+ * @brief 比较表达式
+ * @ingroup Expression
+ */
 class ComparisonExpr : public Expression 
 {
 public:
@@ -240,6 +267,8 @@ class ComparisonExpr : public Expression
 };
 
 /**
+ * @brief 联结表达式
+ * @ingroup Expression
  * 多个表达式使用同一种关系(AND或OR)来联结
  * 当前miniob仅有AND操作
  */

src/observer/sql/expr/tuple_cell.h

@@ -18,7 +18,8 @@ See the Mulan PSL v2 for more details. */
 #include "storage/table/table.h"
 #include "storage/field/field_meta.h"
 
-class TupleCellSpec {
+class TupleCellSpec
+{
 public:
   TupleCellSpec(const char *table_name, const char *field_name, const char *alias = nullptr);
   TupleCellSpec(const char *alias);

src/observer/sql/parser/parse_defs.h

@@ -52,10 +52,10 @@ enum CompOp
 enum AttrType
 {
   UNDEFINED,
-  CHARS,          /// 字符串类型
-  INTS,           /// 整数类型(4字节)
-  FLOATS,         /// 浮点数类型(4字节)
-  BOOLEANS,       /// boolean类型，当前不是由parser解析出来的，是程序内部使用的
+  CHARS,          ///< 字符串类型
+  INTS,           ///< 整数类型(4字节)
+  FLOATS,         ///< 浮点数类型(4字节)
+  BOOLEANS,       ///< boolean类型，当前不是由parser解析出来的，是程序内部使用的
 };
 
 /**
@@ -64,14 +64,14 @@ enum AttrType
  */
 struct Value
 {
-  AttrType    type;           /// 属性的类型
-  int         int_value;      /// 如果是整数，这个值就有意义
-  float       float_value;    /// 如果是浮点数，这个值就有意义
-  bool        bool_value;     /// 如果是boolean值，这个值就有意义
-  std::string string_value;   /// 如果是字符串，这个值就有意义
+  AttrType    type;           ///< 属性的类型
+  int         int_value;      ///< 如果是整数，这个值就有意义
+  float       float_value;    ///< 如果是浮点数，这个值就有意义
+  bool        bool_value;     ///< 如果是boolean值，这个值就有意义
+  std::string string_value;   ///< 如果是字符串，这个值就有意义
 
-  const char *data() const;   /// 获取值的内存地址
-  int length();               /// 获取占用的内存长度
+  const char *data() const;   ///< 获取值的内存地址
+  int length();               ///< 获取占用的内存长度
 };
 
 /**
@@ -105,9 +105,9 @@ struct Condition
  */
 struct Selects
 {
-  std::vector<RelAttr> attributes;    /// attributes in select clause
-  std::vector<std::string> relations; /// 查询的表
-  std::vector<Condition> conditions;  /// 查询条件，使用AND串联起来多个条件
+  std::vector<RelAttr> attributes;    ///< attributes in select clause
+  std::vector<std::string> relations; ///< 查询的表
+  std::vector<Condition> conditions;  ///< 查询条件，使用AND串联起来多个条件
 };
 
 /**
@@ -116,8 +116,8 @@ struct Selects
  */
 struct Inserts
 {
-  std::string relation_name;  /// Relation to insert into
-  std::vector<Value> values;  /// 要插入的值
+  std::string relation_name;  ///< Relation to insert into
+  std::vector<Value> values;  ///< 要插入的值
 };
 
 /**
@@ -135,9 +135,9 @@ struct Deletes
  */
 struct Updates
 {
-  std::string relation_name;   // Relation to update
-  std::string attribute_name;  /// 更新的字段，仅支持一个字段
-  Value value;                 /// 更新的值，仅支持一个字段
+  std::string relation_name;   ///< Relation to update
+  std::string attribute_name;  ///< 更新的字段，仅支持一个字段
+  Value value;                 ///< 更新的值，仅支持一个字段
   std::vector<Condition> conditions;
 };
 
@@ -149,9 +149,9 @@ struct Updates
  */
 struct AttrInfo
 {
-  AttrType type;     /// Type of attribute
-  std::string name;  /// Attribute name
-  size_t length;     /// Length of attribute
+  AttrType type;     ///< Type of attribute
+  std::string name;  ///< Attribute name
+  size_t length;     ///< Length of attribute
 };
 
 /**
@@ -191,8 +191,8 @@ struct CreateIndex
  */
 struct DropIndex
 {
-  std::string index_name;     // Index name
-  std::string relation_name;  // Relation name
+  std::string index_name;     ///< Index name
+  std::string relation_name;  ///< Relation name
 };
 
 /**