From 5df31f2dbfe6026742e04e785c543eb9405b8b7e Mon Sep 17 00:00:00 2001
From: Frans de Jonge <fransdejonge@gmail.com>
Date: Sun, 9 Jun 2019 15:50:22 +0200
Subject: [PATCH] [doc, fix] Some documentation issues (#5066)

Fixes #5065.
---
 .../ui/data/keyboardlayouts/ko_KR_helper.lua  | 48 +++++++++----------
 frontend/version.lua                          |  2 +-
 2 files changed, 25 insertions(+), 25 deletions(-)

diff --git a/frontend/ui/data/keyboardlayouts/ko_KR_helper.lua b/frontend/ui/data/keyboardlayouts/ko_KR_helper.lua
index 0bd1763c2..fa827e399 100644
--- a/frontend/ui/data/keyboardlayouts/ko_KR_helper.lua
+++ b/frontend/ui/data/keyboardlayouts/ko_KR_helper.lua
@@ -1,30 +1,30 @@
--- require('utf8')
+--[[--
+
+# Hangul-input-method Kit for Lua/KOReader
+
+## Input method implemented: 2-beolsik (for simplicity, can retrieve many articles for implementation)
+## Classes and their features
+
+ * HgSylbls (= Hangul Syllables)
+   - Determine if a character is in Hangul consonnant, vowel, initial, medial, or final character
+   - Combine initial, medial[, and final] character into a complete syllables
+   - Determine if a medial (or final) character can be a double one (can combine another medial (or final) one)
+ * HgFSM (= Hangul Finite State Machine)
+   - Process Hangul syllabus combination if the character that user inputs are valid one to be combined
+ * UIHandler
+   - To communicate with the actual UI text input box
+
+## References
+<https://ehclub.co.kr/2482>
+:: Hangul syllables combination formula, Hangul unicode composition, FSM reference
+<https://en.wikipedia.org/wiki/Hangul_consonant_and_vowel_tables>
+
+--]]
+
 local BaseUtil = require("ffi/util")
 local logger = require("logger")
 
---------
--- # Hangul-input-method Kit for Lua/KOReader
---------
--- ## Input method implemented: 2-beolsik (for simplicity, can retrieve many articles for implementation)
--- ## Classes and their features
---  * HgSylbls (= Hangul Syllables)
---    - Determine if a character is in Hangul consonnant, vowel, initial, medial, or final character
---    - Combine initial, medial[, and final] character into a complete syllables
---    - Determine if a medial (or final) character can be a double one (can combine another medial (or final) one)
---  * HgFSM (= Hangul Finite State Machine)
---    - Process Hangul syllabus combination if the character that user inputs are valid one to be combined
---  * UIHandler
---    - To communicate with the actual UI text input box
---
--- ## References
--- https://ehclub.co.kr/2482
--- :: Hangul syllables combination formula, Hangul unicode composition, FSM reference
--- https://en.wikipedia.org/wiki/Hangul_consonant_and_vowel_tables
---------
-
-----------------------
--- Hangul Syllables --
-----------------------
+-- Hangul Syllables
 
 local HgSylbls = {
     -- Hangul character ranges in Unicode
diff --git a/frontend/version.lua b/frontend/version.lua
index ee5f2f3cf..6430d1bb4 100644
--- a/frontend/version.lua
+++ b/frontend/version.lua
@@ -42,7 +42,7 @@ end
 --- Returns current version of KOReader.
 -- @treturn int version in the form of a 10 digit number such as `2015110982`
 -- @treturn string short git commit version hash such as `704d4238`
--- @see normalized_version
+-- @see getNormalizedVersion
 function Version:getNormalizedCurrentVersion()
     if not self.version or not self.commit then
         self.version, self.commit = self:getNormalizedVersion(self:getCurrentRevision())