[doc, fix] Some documentation issues (#5066)

Fixes #5065.
pull/5068/head
Frans de Jonge 5 years ago committed by GitHub
parent 2f335e2e6e
commit 5df31f2dbf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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

@ -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())

Loading…
Cancel
Save