Improve documentation.

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@9093 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

6 files changed, 24 insertions, 12 deletions

diff --git a/activesupport/lib/active_support/json/encoders/date.rb b/activesupport/lib/active_support/json/encoders/date.rb
index 853d9b868c..d55f17962b 100644
--- a/activesupport/lib/active_support/json/encoders/date.rb
+++ b/activesupport/lib/active_support/json/encoders/date.rb
@@ -1,5 +1,10 @@
 class Date
-  def to_json(options = nil) #:nodoc:
+  # Returns a JSON string representing the date.
+  #
+  # ==== Example:
+  #   Date.new(2005,2,1).to_json
+  #   # => "2005/02/01"
+  def to_json(options = nil)
     %("#{strftime("%Y/%m/%d")}")
   end
 end
diff --git a/activesupport/lib/active_support/json/encoders/date_time.rb b/activesupport/lib/active_support/json/encoders/date_time.rb
index f0b0434412..380361c360 100644
--- a/activesupport/lib/active_support/json/encoders/date_time.rb
+++ b/activesupport/lib/active_support/json/encoders/date_time.rb
@@ -1,5 +1,10 @@
 class DateTime
-  def to_json(options = nil) #:nodoc:
+  # Returns a JSON string representing the datetime.
+  #
+  # ==== Example:
+  #   DateTime.civil(2005,2,1,15,15,10).to_json
+  #   # => "2005/02/01 15:15:10 +0000"
+  def to_json(options = nil)
     %("#{strftime("%Y/%m/%d %H:%M:%S %z")}")
   end
 end
diff --git a/activesupport/lib/active_support/json/encoders/enumerable.rb b/activesupport/lib/active_support/json/encoders/enumerable.rb
index 720fd88f90..881b1d62c1 100644
--- a/activesupport/lib/active_support/json/encoders/enumerable.rb
+++ b/activesupport/lib/active_support/json/encoders/enumerable.rb
@@ -2,8 +2,8 @@ module Enumerable
   # Returns a JSON string representing the enumerable. Any +options+
   # given will be passed on to its elements. For example:
   #
-  # users = User.find(:all)
-  # users.to_json(:only => :name)
+  #   users = User.find(:all)
+  #   # => users.to_json(:only => :name)
   #
   # will pass the <tt>:only => :name</tt> option to each user.
   def to_json(options = {}) #:nodoc:
diff --git a/activesupport/lib/active_support/json/encoders/hash.rb b/activesupport/lib/active_support/json/encoders/hash.rb
index 774803d64f..b9bdd55fa5 100644
--- a/activesupport/lib/active_support/json/encoders/hash.rb
+++ b/activesupport/lib/active_support/json/encoders/hash.rb
@@ -5,8 +5,7 @@ class Hash
   # the hash keys. For example:
   #
   #   { :name => "Konata Izumi", 'age' => 16, 1 => 2 }.to_json
-  #
-  #   {"name": "Konata Izumi", 1: 2, "age": 16}
+  #   # => {"name": "Konata Izumi", 1: 2, "age": 16}
   #
   # The keys in the JSON string are unordered due to the nature of hashes.
   #
@@ -14,12 +13,10 @@ class Hash
   # attributes included, and will accept 1 or more hash keys to include/exclude.
   #
   #   { :name => "Konata Izumi", 'age' => 16, 1 => 2 }.to_json(:only => [:name, 'age'])
-  #
-  #   {"name": "Konata Izumi", "age": 16}
+  #   # => {"name": "Konata Izumi", "age": 16}
   #
   #   { :name => "Konata Izumi", 'age' => 16, 1 => 2 }.to_json(:except => 1)
-  #
-  #   {"name": "Konata Izumi", "age": 16}
+  #   # => {"name": "Konata Izumi", "age": 16}
   #
   # The +options+ also filter down to any hash values. This is particularly
   # useful for converting hashes containing ActiveRecord objects or any object
diff --git a/activesupport/lib/active_support/json/encoders/object.rb b/activesupport/lib/active_support/json/encoders/object.rb
index 6da0d1d1c1..ca215d4964 100644
--- a/activesupport/lib/active_support/json/encoders/object.rb
+++ b/activesupport/lib/active_support/json/encoders/object.rb
@@ -1,5 +1,5 @@
 class Object
-  # Dumps object in JSON (JavaScript Object Notation).  See www.json.org for more info.
+  # Dumps object in JSON (JavaScript Object Notation). See www.json.org for more info.
   def to_json(options = {})
     ActiveSupport::JSON.encode(instance_values, options)
   end
diff --git a/activesupport/lib/active_support/json/encoders/time.rb b/activesupport/lib/active_support/json/encoders/time.rb
index 4f964a92e0..b0c9189c78 100644
--- a/activesupport/lib/active_support/json/encoders/time.rb
+++ b/activesupport/lib/active_support/json/encoders/time.rb
@@ -1,5 +1,10 @@
 class Time
-  def to_json(options = nil) #:nodoc:
+  # Returns a JSON string representing the time.
+  #
+  # ==== Example:
+  #   Time.utc(2005,2,1,15,15,10).to_json
+  #   # => 2005/02/01 15:15:10 +0000"
+  def to_json(options = nil)
     %("#{strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)}")
   end
 end