From 1c3b6e900d9b23e8a1f34f1c5b7b9657bd7c1451 Mon Sep 17 00:00:00 2001
From: Titus Wormer <tituswormer@gmail.com>
Date: Thu, 7 Jul 2022 17:56:37 +0200
Subject: Add docs for block quote tokens

---
 src/tokenizer.rs | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 76 insertions(+), 1 deletion(-)

(limited to 'src/tokenizer.rs')

diff --git a/src/tokenizer.rs b/src/tokenizer.rs
index 069134a..c1a23eb 100644
--- a/src/tokenizer.rs
+++ b/src/tokenizer.rs
@@ -113,10 +113,85 @@ pub enum TokenType {
     ///       ^
     /// ```
     BlankLineEnding,
+    /// Whole block quote.
+    ///
+    /// ## Info
+    ///
+    /// *   **Context**:
+    ///     [document content][crate::content::document]
+    /// *   **Content model**:
+    ///     [`BlockQuotePrefix`][TokenType::BlockQuotePrefix],
+    ///     [flow content][crate::content::flow]
+    /// *   **Construct**:
+    ///     [`block_quote`][crate::construct::block_quote]
+    ///
+    /// ## Example
+    ///
+    /// ```markdown
+    /// > | > a
+    ///     ^^^
+    /// > | b
+    ///     ^
+    /// ```
     BlockQuote,
+    /// Block quote marker.
+    ///
+    /// ## Info
+    ///
+    /// *   **Context**:
+    ///     [`BlockQuotePrefix`][TokenType::BlockQuotePrefix]
+    /// *   **Content model**:
+    ///     void
+    /// *   **Construct**:
+    ///     [`block_quote`][crate::construct::block_quote]
+    ///
+    /// ## Example
+    ///
+    /// ```markdown
+    /// > | > a
+    ///     ^
+    ///   | b
+    /// ```
     BlockQuoteMarker,
+    /// Block quote prefix.
+    ///
+    /// ## Info
+    ///
+    /// *   **Context**:
+    ///     [`BlockQuote`][TokenType::BlockQuote]
+    /// *   **Content model**:
+    ///     [`BlockQuoteMarker`][TokenType::BlockQuoteMarker],
+    ///     [`BlockQuoteWhitespace`][TokenType::BlockQuoteWhitespace]
+    /// *   **Construct**:
+    ///     [`block_quote`][crate::construct::block_quote]
+    ///
+    /// ## Example
+    ///
+    /// ```markdown
+    /// > | > a
+    ///     ^^
+    ///   | b
+    /// ```
     BlockQuotePrefix,
-    BlockQuotePrefixWhitespace,
+    /// Block quote white space.
+    ///
+    /// ## Info
+    ///
+    /// *   **Context**:
+    ///     [`BlockQuotePrefix`][TokenType::BlockQuotePrefix]
+    /// *   **Content model**:
+    ///     void
+    /// *   **Construct**:
+    ///     [`block_quote`][crate::construct::block_quote]
+    ///
+    /// ## Example
+    ///
+    /// ```markdown
+    /// > | > a
+    ///      ^
+    ///   | b
+    /// ```
+    BlockQuoteWhitespace,
     /// Whole character escape.
     ///
     /// ## Info
-- 
cgit