fix doc

xring · Apr 6, 2024 · bff6282 · bff6282
1 parent e1dc41b
commit bff6282
Show file tree

Hide file tree

Showing 12 changed files with 231 additions and 231 deletions.
diff --git a/src/common/key_part.rs b/src/common/key_part.rs
@@ -10,15 +10,15 @@ use base::error::ParseSQLError;
 use common::OrderType;
 use common::{sql_identifier, ws_sep_comma};
 
-/// key_part: {col_name [(length)] | (expr)} [ASC | DESC]
+/// key_part: {col_name \[(length)] | (expr)} \[ASC | DESC]
 #[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
 pub struct KeyPart {
     r#type: KeyPartType,
     order: Option<OrderType>,
 }
 
 impl KeyPart {
-    /// key_part: {col_name [(length)] | (expr)} [ASC | DESC]
+    /// key_part: {col_name \[(length)] | (expr)} \[ASC | DESC]
     fn parse(i: &str) -> IResult<&str, KeyPart, ParseSQLError<&str>> {
         map(
             tuple((
@@ -33,7 +33,7 @@ impl KeyPart {
     }
 
     /// (key_part,...)
-    /// key_part: {col_name [(length)] | (expr)} [ASC | DESC]
+    /// key_part: {col_name \[(length)] | (expr)} \[ASC | DESC]
     pub fn key_part_list(i: &str) -> IResult<&str, Vec<KeyPart>, ParseSQLError<&str>> {
         map(
             tuple((
@@ -53,7 +53,7 @@ impl KeyPart {
     }
 }
 
-/// {col_name [(length)] | (expr)}
+/// {col_name \[(length)] | (expr)}
 #[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
 pub enum KeyPartType {
     ColumnNameWithLength {
@@ -66,7 +66,7 @@ pub enum KeyPartType {
 }
 
 impl KeyPartType {
-    /// {col_name [(length)] | (expr)}
+    /// {col_name \[(length)] | (expr)}
     fn parse(i: &str) -> IResult<&str, KeyPartType, ParseSQLError<&str>> {
         // {col_name [(length)]
         let col_name_with_length = tuple((

diff --git a/src/common/mod.rs b/src/common/mod.rs
@@ -322,7 +322,7 @@ impl IndexOrKeyType {
     }
 }
 
-/// [CONSTRAINT [symbol]] CHECK (expr) [[NOT] ENFORCED]
+/// \[CONSTRAINT \[symbol]] CHECK (expr) \[\[NOT] ENFORCED]
 #[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
 pub struct CheckConstraintDefinition {
     pub symbol: Option<String>,
@@ -368,7 +368,7 @@ impl IndexType {
         )(i)
     }
 
-    /// [index_type]
+    /// \[index_type]
     /// USING {BTREE | HASH}
     pub fn opt_index_type(i: &str) -> IResult<&str, Option<IndexType>, ParseSQLError<&str>> {
         opt(map(
@@ -388,7 +388,7 @@ impl fmt::Display for IndexType {
     }
 }
 
-/// [index_name]
+/// \[index_name]
 pub fn opt_index_name(i: &str) -> IResult<&str, Option<String>, ParseSQLError<&str>> {
     opt(map(
         delimited(multispace1, sql_identifier, multispace0),

diff --git a/src/common/reference_definition.rs b/src/common/reference_definition.rs
@@ -22,7 +22,7 @@ impl ReferenceDefinition {
     ///     REFERENCES tbl_name (key_part,...)
     ///       [MATCH FULL | MATCH PARTIAL | MATCH SIMPLE]
     ///       [ON DELETE reference_option]
-    ///       [ON UPDATE reference_option]
+    ///       \[ON UPDATE reference_option]
     pub fn parse(i: &str) -> IResult<&str, ReferenceDefinition, ParseSQLError<&str>> {
         let opt_on_delete = opt(map(
             tuple((