added documentation for trust_input and gemspec update.

1 files changed, 11 insertions, 2 deletions

diff --git a/lib/axlsx.rb b/lib/axlsx.rb
index c5fcfed0..ed7a141f 100644
--- a/lib/axlsx.rb
+++ b/lib/axlsx.rb
@@ -124,10 +124,19 @@ module Axlsx
     s = s.capitalize if all_caps
     s.gsub(/_(.)/){ $1.upcase }
   end
+
+
+  # Instructs the serializer to not try to escape cell value input. 
+  # This will give you a huge speed bonus, but if you content has <, > or other xml character data
+  # the workbook will be invalid and excel will complain.
   def self.trust_input
     @trust_input ||= false
   end
-  def self.trust_input=(v)
-    @trust_input=v
+
+  # @param[Boolean] trust_me A boolean value indicating if the cell value content is to be trusted
+  # @return [Boolean]
+  # @see Axlsx::trust_input
+  def self.trust_input=(trust_me)
+    @trust_input = trust_me
   end
 end