add basic PinyinVariant info

chewing · Dec 26, 2024 · 365897a · 365897a
1 parent 786b0ff
commit 365897a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/src/editor/zhuyin_layout/hsu.rs b/src/editor/zhuyin_layout/hsu.rs
@@ -21,6 +21,15 @@ impl Hsu {
             syllable: Default::default(),
         }
     }
+
+    ///
+    /// tone key is hsu_end_key
+    ///  KeyCode::S -> Bopomofo::TONE5
+    ///  KeyCode::D -> Bopomofo::TONE2
+    ///  KeyCode::F -> Bopomofo::TONE3
+    ///  KeyCode::J -> Bopomofo::TONE4
+    ///  KeyCode::Space -> Bopomofo::TONE1
+    ///
     fn is_hsu_end_key(&self, key: KeyEvent) -> bool {
         // TODO allow customize end key mapping
         match key.code {

diff --git a/src/editor/zhuyin_layout/pinyin.rs b/src/editor/zhuyin_layout/pinyin.rs
@@ -12,16 +12,19 @@ const MAX_PINYIN_LEN: usize = 10;
 /// TODO: docs
 #[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
 pub enum PinyinVariant {
-    /// TODO: docs
+    /// [Hanyu Pinyin](https://en.wikipedia.org/wiki/Pinyin), or simply pinyin
     #[default]
     HanyuPinyin,
-    /// TODO: docs
+    /// [THL, Taíwan Huáyǔ Luómǎ Pinyin](https://pinyin.thl.tw/)
     ThlPinyin,
-    /// TODO: docs
+    /// [MPS2, Mandarin Phonetic Symbols II](https://pinyin.info/romanization/mps2)
     Mps2Pinyin,
 }
 
-/// TODO: docs
+/// Pinyin
+///
+/// Current support types: [`PinyinVariant`](enum@PinyinVariant)
+///
 #[derive(Default, Debug, Clone)]
 pub struct Pinyin {
     key_seq: String,