Merge pull request #2 from denvazh/update-documentation

Update documentation
denvazh · Oct 10, 2015 · 49b8f87 · 49b8f87
2 parents c1e6051 + e3d10f6
commit 49b8f87
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/denvazh/faker_japanese.svg?branch=master)](https://travis-ci.org/denvazh/faker_japanese)
 [![Coverage Status](https://coveralls.io/repos/denvazh/faker_japanese/badge.svg?branch=master&service=github)](https://coveralls.io/github/denvazh/faker_japanese?branch=master)
+[![Inline docs](http://inch-ci.org/github/denvazh/faker_japanese.svg?branch=master)](http://inch-ci.org/github/denvazh/faker_japanese)
 
 Faker extension to generate Japanese names.
 Provides fake first and last names in kanji, hiragana, katakana and romaji (name written with latin alphabet).

diff --git a/lib/faker_japanese.rb b/lib/faker_japanese.rb
@@ -10,7 +10,12 @@ module Japanese
 
     # Kanji string
     class Kanji < String
-      attr_reader :yomi, :kana, :romaji
+      # @return [String] hiragana form
+      attr_reader :yomi
+      # @return [String] katakana form
+      attr_reader :kana
+      # @return [String] romanized form
+      attr_reader :romaji
 
       # Create new Kanji string instance
       # @param [String] kanji string in kanji from