summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorFlorian Frank <flori@ping.de>2009-11-05 18:39:16 +0100
committerFlorian Frank <flori@ping.de>2009-11-05 18:39:16 +0100
commit16ec09d6af3e109400f5a64454b2dd38488e3ded (patch)
tree18a445607862295af26727a8b9b6b24ce5b4f6db /lib
parent1e366a222abf3f7232b427ce968675d3a906b90c (diff)
downloadjson-16ec09d6af3e109400f5a64454b2dd38488e3ded.tar.gz
added docu, some methods renamed
Diffstat (limited to 'lib')
-rw-r--r--lib/json/pure/generator.rb4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/json/pure/generator.rb b/lib/json/pure/generator.rb
index 8358988..256bdb5 100644
--- a/lib/json/pure/generator.rb
+++ b/lib/json/pure/generator.rb
@@ -216,7 +216,9 @@ module JSON
result
end
- # XXX
+ # Generates a valid JSON document from object +obj+ and returns the
+ # result. If no valid JSON document can be created this method raises a
+ # GeneratorError exception.
def generate(obj)
result = obj.to_json(self)
if result !~ /\A\s*(?:\[.*\]|\{.*\})\s*\Z/m