Merge pull request #211 from vipulnsward/complex-doc

Document `Complex` json generation methods.

1 files changed, 7 insertions, 1 deletions

diff --git a/lib/json/add/complex.rb b/lib/json/add/complex.rb
index d7ebebf..2723f60 100644
--- a/lib/json/add/complex.rb
+++ b/lib/json/add/complex.rb
@@ -4,10 +4,15 @@ end
 defined?(::Complex) or require 'complex'
 
 class Complex
+
+  # Deserializes JSON string by converting Real value <tt>r</tt>, imaginary
+  # value <tt>i</tt>, to a Complex object.
   def self.json_create(object)
     Complex(object['r'], object['i'])
   end
 
+  # Returns a hash, that will be turned into a JSON object and represent this
+  # object.
   def as_json(*)
     {
       JSON.create_id => self.class.name,
@@ -16,7 +21,8 @@ class Complex
     }
   end
 
+  # Stores class name (Complex) along with real value <tt>r</tt> and imaginary value <tt>i</tt> as JSON string
   def to_json(*)
     as_json.to_json
   end
-end
+end
\ No newline at end of file