Refactor examples of states

1 files changed, 42 insertions, 15 deletions

diff --git a/src/construct/character_reference.rs b/src/construct/character_reference.rs
index 2bfed45..544458a 100644
--- a/src/construct/character_reference.rs
+++ b/src/construct/character_reference.rs
@@ -71,16 +71,32 @@ use crate::tokenizer::{Code, State, StateFnResult, Tokenizer};
 /// Kind of a character reference.
 #[derive(Debug, Clone, PartialEq)]
 pub enum Kind {
-    /// Numeric decimal character reference (`	`).
+    /// Numeric decimal character reference.
+    ///
+    /// ```markdown
+    /// > | a	b
+    ///      ^^^^^
+    /// ```
     Decimal,
-    /// Numeric hexadecimal character reference (`{`).
+    /// Numeric hexadecimal character reference.
+    ///
+    /// ```markdown
+    /// > | a{b
+    ///      ^^^^^^
+    /// ```
     Hexadecimal,
-    /// Named character reference (`&`).
+    /// Named character reference.
+    ///
+    /// ```markdown
+    /// > | a&b
+    ///      ^^^^^
+    /// ```
     Named,
 }
 
 impl Kind {
-    /// Get the maximum size of characters allowed in a character reference.
+    /// Get the maximum size of characters allowed in the value of a character
+    /// reference.
     fn max(&self) -> usize {
         match self {
             Kind::Hexadecimal => CHARACTER_REFERENCE_HEXADECIMAL_SIZE_MAX,
@@ -113,9 +129,12 @@ struct Info {
 /// Start of a character reference.
 ///
 /// ```markdown
-/// a|&b
-/// a|{b
-/// a|	b
+/// > | a&b
+///      ^
+/// > | a{b
+///      ^
+/// > | a	b
+///      ^
 /// ```
 pub fn start(tokenizer: &mut Tokenizer, code: Code) -> StateFnResult {
     match code {
@@ -134,9 +153,12 @@ pub fn start(tokenizer: &mut Tokenizer, code: Code) -> StateFnResult {
 /// or an alphanumeric for named references.
 ///
 /// ```markdown
-/// a&|amp;b
-/// a&|#123;b
-/// a&|#x9;b
+/// > | a&b
+///       ^
+/// > | a{b
+///       ^
+/// > | a	b
+///       ^
 /// ```
 fn open(tokenizer: &mut Tokenizer, code: Code) -> StateFnResult {
     let info = Info {
@@ -158,8 +180,10 @@ fn open(tokenizer: &mut Tokenizer, code: Code) -> StateFnResult {
 /// or a digit for decimals.
 ///
 /// ```markdown
-/// a&#|123;b
-/// a&#|x9;b
+/// > | a{b
+///        ^
+/// > | a	b
+///        ^
 /// ```
 fn numeric(tokenizer: &mut Tokenizer, code: Code, mut info: Info) -> StateFnResult {
     if let Code::Char('x' | 'X') = code {
@@ -182,9 +206,12 @@ fn numeric(tokenizer: &mut Tokenizer, code: Code, mut info: Info) -> StateFnResu
 /// allowed.
 ///
 /// ```markdown
-/// a&a|mp;b
-/// a&#1|23;b
-/// a&#x|9;b
+/// > | a&b
+///       ^^^
+/// > | a{b
+///        ^^^
+/// > | a	b
+///         ^
 /// ```
 fn value(tokenizer: &mut Tokenizer, code: Code, mut info: Info) -> StateFnResult {
     match code {