+//===------------------------------------------------------------------------------------------===//
+//
 // Romanize.swift
 //
+// Romanizes a String of (Korean) Hangul Characters
+// Supports Hangul Unicode Syllables U+AC00 - U+D7A3
+// Using Revised Romanization of Korean
+// See https://en.wikipedia.org/wiki/Revised_Romanization_of_Korean
+//
+// Author Philipp Dylong
+//
+// See https://github.com/creekpld/romanize
+//
 // Acknowledgements:
-// The Hangul Character Decomposition code is from here: https://github.com/cheunghy/kroman-swift
+// hangul character decomposition algorithm
+// See https://github.com/zhangkaiyulw/kroman-swift
+//
+//===------------------------------------------------------------------------------------------===//
 
 import Foundation
-// TODO: in Swift 4.2 use Int.random(in: 0 ..< 10) instead of arc4random() and remove import Foundation
-
-
-public class Romanize{
+
+/* Romanize
+Use this class and it's fluent API methodes to customize the syllable divider,
+the romanization of every jamo and to generate random hangul characters.
+*/
+public class Romanize {
     
     public init() {
         #if os(Linux)

    }
}


public func romanize(_ text: String, _ divideSyllables: Bool = false) -> String {
    let r = Romanize()
    return r.romanize(text, divideSyllables)

        }
        return textOut
    }
    
    /// Revised Romanization of Korean Initial Consonant letters
    private var headJamos = [
        ["g",   "ㄱ"],
