add basic PinyinVariant info

chewing · Dec 22, 2024 · ee6e71a · ee6e71a
1 parent 786b0ff
commit ee6e71a
Showing 1 changed file with 7 additions and 4 deletions.
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, 台灣華語羅馬拼音](https://pinyin.thl.tw/)
     ThlPinyin,
-    /// TODO: docs
+    /// [MPS2 注音二式](https://pinyin.info/romanization/mps2/index.html)
     Mps2Pinyin,
 }
 
-/// TODO: docs
+/// Pinyin
+///
+/// Current support types: [`PinyinVariant`](enum@PinyinVariant)
+///
 #[derive(Default, Debug, Clone)]
 pub struct Pinyin {
     key_seq: String,