summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVipul A M <vipulnsward@gmail.com>2014-07-03 10:49:29 +0530
committerVipul A M <vipulnsward@gmail.com>2014-07-03 10:49:29 +0530
commitfdba825edd018f237a17637d00529d2d31a1b144 (patch)
tree267e4149b595878674e2c72cbde5207624b2b6ac
parentb93b23d87458bc1999ea9829926a097ff5b45213 (diff)
downloadjson-fdba825edd018f237a17637d00529d2d31a1b144.tar.gz
Document `Complex` json generation methods.
-rw-r--r--lib/json/add/complex.rb8
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