Updated readme and docs for pre 1.3.4 release

6 files changed, 38 insertions, 16 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7f8a3571..a1e392ff 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,19 @@
 CHANGELOG
 ---------
+
+- **September.30.12**: 1.3.1
+  - Improved control character handling
+  - Added stored auto filter values and date grouping items
+  - Improved support for autowidth when custom styles are applied
+  - Added support for table style info that lets you take advantage of
+    all the predefined table styles.
+  - Improved style management for fonts so they merge undefined values
+    from the initial master.
+- **September.8.12**: 1.2.3
+  - enhance exponential float/bigdecimal values rendering as strings intead
+    of 'numbers' in excel.
+  - added support for :none option on chart axis labels
+  - added support for paper_size option on worksheet.page_setup
 - **August.27.12**: 1.2.2
    - minor patch for auto-filters
    - minor documentation improvements.
diff --git a/README.md b/README.md
index 7a49e564..061407cb 100644
--- a/README.md
+++ b/README.md
@@ -101,6 +101,9 @@ and Numbers
 
 **19. Data labels for charts as well as series color customization.
 
+**20. Support for sheet headers and footers
+
+
 Installing
 ----------
 
@@ -149,10 +152,11 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
-- **November.??.12**:1.3.4
+- **November.25.12**:1.3.4
   - Support for headers and footers for worksheets
-  - Patch to properly escape hyperlink urls
+  - bug fix: Properly escape hyperlink urls
   - Improvements in color_scale generation for conditional formatting
+  - Improvements in autowidth calculation.
 - **November.8.12**:1.3.3
   - Patched cell run styles for u and validation for family
 - **November.5.12**:1.3.2
@@ -163,19 +167,6 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
   - added insert_worksheet so you can now add a worksheet to an
     arbitrary position in the worksheets list.
   - reduced memory consumption for package parts post serialization
-- **September.30.12**: 1.3.1
-  - Improved control character handling
-  - Added stored auto filter values and date grouping items
-  - Improved support for autowidth when custom styles are applied
-  - Added support for table style info that lets you take advantage of
-    all the predefined table styles.
-  - Improved style management for fonts so they merge undefined values
-    from the initial master.
-- **September.8.12**: 1.2.3
-  - enhance exponential float/bigdecimal values rendering as strings intead
-    of 'numbers' in excel.
-  - added support for :none option on chart axis labels
-  - added support for paper_size option on worksheet.page_setup
 
 Please see the {file:CHANGELOG.md} document for past release information.
 
@@ -251,6 +242,7 @@ done without the help of the people below.
 
 [adammathys](https://github.com/adammathys) - Fgr getting our head in the
 air and our feet on the ground.
+
 #Copyright and License
 ----------
 
diff --git a/Rakefile b/Rakefile
index 01a55527..227ecfc2 100644
--- a/Rakefile
+++ b/Rakefile
@@ -11,7 +11,7 @@ end
 task :gendoc do
   #puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
     system "yardoc"
-    #system "yard stats --list-undoc"
+    system "yard stats --list-undoc"
 end
 
 task :test do
diff --git a/lib/axlsx/util/serialized_attributes.rb b/lib/axlsx/util/serialized_attributes.rb
index 30fcfaaa..5519f843 100644
--- a/lib/axlsx/util/serialized_attributes.rb
+++ b/lib/axlsx/util/serialized_attributes.rb
@@ -22,10 +22,12 @@ module Axlsx
         @xml_attributes
       end
 
+      # This helper registers the attributes that will be formatted as elements.
       def serializable_element_attributes(*symbols)
         @xml_element_attributes = symbols
       end
 
+      # attr reader for element attributes
       def xml_element_attributes
         @xml_element_attributes
       end
diff --git a/lib/axlsx/util/validators.rb b/lib/axlsx/util/validators.rb
index 55a49e72..cc8f0a92 100644
--- a/lib/axlsx/util/validators.rb
+++ b/lib/axlsx/util/validators.rb
@@ -145,6 +145,7 @@ module Axlsx
     RestrictionValidator.validate "cell run style u", [:none, :single, :double, :singleAccounting, :doubleAccounting], v
   end
 
+  # validates cell style family which must be between 1 and 5 
   def self.validate_family(v)
     RestrictionValidator.validate "cell run style family", 1..5, v
   end
diff --git a/lib/axlsx/workbook/worksheet/color_scale.rb b/lib/axlsx/workbook/worksheet/color_scale.rb
index 2b2c9d41..287e6869 100644
--- a/lib/axlsx/workbook/worksheet/color_scale.rb
+++ b/lib/axlsx/workbook/worksheet/color_scale.rb
@@ -8,15 +8,28 @@ module Axlsx
   class ColorScale
 
     class << self
+
+      # These are the default conditional formatting value objects
+      # that define a two tone color gradient.
       def default_cfvos
         [{:type => :min, :val => 0, :color => 'FFFF7128'},
          {:type => :max, :val => 0, :color => 'FFFFEF9C'}]
       end
 
+      # A builder for two tone color gradient
+      # @example
+      #   # this creates a two tone color scale
+      #   color_scale = Axlsx::ColorScale.two_tone
+      # @see examples/example.rb conditional formatting examples.
       def two_tone
         self.new
       end
 
+      # A builder for three tone color gradient
+      # @example
+      #   #this creates a three tone color scale
+      #   color_scale = Axlsx::ColorScale.three_tone 
+      # @see examples/example.rb conditional formatting examples.
       def three_tone
         self.new({:type => :min, :val => 0, :color => 'FFF8696B'},
                  {:type => :percent, :val => '50', :color => 'FFFFEB84'},