DOC

com.github.jikyo : romaji

Maven & Gradle

May 15, 2019
4 stars

Romaji · `Romaji` is a converter library to romanize Japanese hiragana/katakana string by standard and IME typing style. Even though [icu::Transliterator](http://userguide.icu-project.org/transforms/general) already has provided the same functions, and returns only one romanized string. However, there exists several different romanization systems, so one hiragana/katakana string has so many romanize string. For example, `"ちゃ"` can be romanized as `"cha"`, `"tya"`, `"chixya"`, `"tixya"`, `"chilya"`, or `"tilya"`. `Romaji` provides romanized strings as many as possible. If an input string contained non hiragana/katakana characters (includes kanji), `Romaji` return the characters as same as the input. For example, `Romaji` converts the input `"お茶の水"` to `"o茶no水"`. The mapping from hiragana/katakana to romaji is based on common IME's system to type Japanese on a computer. Therefor, `Romaji` does not directly implement the standard system like Hepburn, Nihon-shiki or Kunrei-shiki, but includes them.

Table Of Contents

Latest Version

Download com.github.jikyo : romaji Javadoc & API Documentation - Latest Versions:

All Versions

Download com.github.jikyo : romaji Javadoc & API Documentation - All Versions:

Version Size Javadoc Updated
0.0.x

How to open Javadoc JAR file in web browser

  1. Rename the file romaji-0.0.4-javadoc.jar to romaji-0.0.4-javadoc.zip
  2. Use your favourite unzip tool (WinRAR / WinZIP) to extract it, now you have a folder romaji-0.0.4-javadoc
  3. Double click index.html will open the index page on your default web browser.

How to generate Javadoc from a source JAR?

Running the command javadoc:

javadoc --ignore-source-errors -encoding UTF-8 -sourcepath "romaji-0.0.4-sources.jar" -d "romaji-0.0.4-javadoc" -subpackages