fixing yarddoc

Author: murb

.yardoc/checksums

@@ -1,22 +1,38 @@
-lib/workbook.rb 32bc69df4e3b8ce2c9268de044456cac6a0bee40
-lib/workbook/row.rb 2ebac27abd51f4858c99c20eaaa51c146820edaf
-lib/workbook/cell.rb e9e8375f8ca39b2d48087d362a894ab41768ea77
-lib/workbook/book.rb 4975414f7982cf0cc30494e209886057c9d4c750
-lib/workbook/sheet.rb 6e4dd25a20aa38932a202bc108de9c4fe99a1d2b
-lib/workbook/table.rb f09a6978e9aeb990b66117906de83fc1c10d1f0c
-lib/workbook/format.rb 2c851e82a2c6b3b7c165d005824d9c0b6eadfa7c
-lib/workbook/version.rb 96df0e31463de68e584e54d3a568988045c08e32
-lib/workbook/template.rb 17d4443a02dab1e7373e0d4ee5d5bb598afbb2f2
-lib/workbook/nil_value.rb 6dd69760293023adf43fb0a8b6cef65f48b0662f
-lib/workbook/readers/csv_reader.rb b04c6dc423a30a87ae957a01229778543840654f
-lib/workbook/readers/xls_reader.rb a42b30bc31731c01c23367450306f849b7b36791
-lib/workbook/readers/ods_reader.rb 8094776c94e46dfb0fb1f293f3e8618692b61e59
-lib/workbook/writers/xls_writer.rb ca52cf9c5c11d1768a96ec33ca48b1f68a59b559
-lib/workbook/readers/txt_reader.rb d954decd6be2b2c7ab7ad60fe68398c428d077cd
-lib/workbook/readers/xls_shared.rb 67da0f89a3b387b6d575df42a3e49f8a53fae49d
-lib/workbook/readers/xlsx_reader.rb 562e664987a4936d9abf89ecb8098744fbb81cf3
+lib/workbook.rb 6438570227f4d8db697a8f875c80e4c1334e99c7
+lib/workbook/row.rb f10c777f11bcf7a03f76615f794ee5730991b097
+lib/workbook/book.rb 0ce5e14b5fabe87cf92a2e09a30779edd5dc2248
+lib/workbook/cell.rb cac1d4b1e42b44059b938ca8b0e521d8fdd002be
+lib/workbook/sheet.rb 5e43246f9fec4db953d6053af8e5b8b16af8ca50
+lib/workbook/table.rb 41cd6aded7748689e9de425e2afd5bc8635c0a5a
+lib/workbook/format.rb 8e8f8c5bd0c9a44d03dd6f4bd787aeb19759688c
+lib/workbook/column.rb 78a5da45e87afea1c489a4fb666e8d923179570b
+lib/workbook/version.rb 020f173233dcaadd7a6f90753bcbc6ab5b8b25cc
+lib/workbook/template.rb 714cf57b0ac43fc020f9bf123d11b5d870851deb
+lib/workbook/types/nil.rb da39a3ee5e6b4b0d3255bfef95601890afd80709
+lib/workbook/nil_value.rb e773e3b95466dc0ef907ea187e692a82f9752764
+lib/workbook/types/date.rb 1f6cd471a88c6a03b02dda54bfa86e70c914d612
+lib/workbook/types/time.rb b7a4c25a9236ff9bfea79334c8c7b126ad98177a
+lib/workbook/types/true.rb da39a3ee5e6b4b0d3255bfef95601890afd80709
+lib/workbook/types/false.rb da39a3ee5e6b4b0d3255bfef95601890afd80709
+lib/workbook/types/string.rb 7d9138192f5b597027a1e6039d0e4d24732b32c5
+lib/workbook/modules/cell.rb 336687a768edc50e5dcf056c775cd052b7257220
+lib/workbook/generatetypes.rb ed30aeac0037757d9fd170962440b4c31ea35ba5
+lib/workbook/types/numeric.rb cc3b3c332d3fd714aac2f61cd1b297461a177121
+lib/workbook/modules/cache.rb 4f493b5da9725b1dba8b0d4c5e50f260cbe71846
+lib/workbook/types/nil_class.rb bde80579120dda2ea26006ebd213a9f5806b34fe
+lib/workbook/types/true_class.rb 58426c452b1146f9c7f466817c5a34c5d87bf8bf
+lib/workbook/types/false_class.rb b462a69a094c0ad7a694de1c3ca8868486a10f24
+lib/workbook/modules/diff_sort.rb 2d634c089d2dd98cca57a90e62fa6d8b5adf876d
+lib/workbook/readers/xls_reader.rb 9993723162e63a372f44fbdffeadf779a7c99ec5
+lib/workbook/readers/ods_reader.rb 15d6203b19c86dd735d46f7f2e98e3d1cbaaacfc
+lib/workbook/readers/csv_reader.rb faa57ea04511f22d2e111f358aac9291dbe17acd
+lib/workbook/writers/xls_writer.rb cca4a524506e04dfe23d60fb364e7878a8f5120f
+lib/workbook/readers/txt_reader.rb 65a16f46aac4debcfe4aab45494de87d785f5ae2
+lib/workbook/readers/xls_shared.rb 4cb1a5cc897a2578bb5ba02eaceccda01627dc34
 lib/workbook/modules/type_parser.rb a933dd8ba9566c13cd61999ada9ffb431c402444
-lib/workbook/writers/html_writer.rb 0671601948122a46e9ea7cd0888378256560f6f9
-lib/workbook/modules/table_diff_sort.rb cffe0ffc3cd71d79ea8fcd67fad363b63292c005
-lib/workbook/writers/csv_table_writer.rb 9ea2161c399c37a172b6a4a95dcaefc95ab47ece
-lib/workbook/modules/raw_objects_storage.rb 3b9a499c170f1e82a2750dbfa247b4a1c2eb0e20
+lib/workbook/writers/html_writer.rb 44adc88d7faa0e09d3684d005473069149503d0e
+lib/workbook/readers/xlsx_reader.rb 632564692d893df9968828380bcab15a0a90ea47
+lib/workbook/writers/xlsx_writer.rb ea165031771b18e48c34863a48de05a667546d3a
+lib/workbook/writers/csv_table_writer.rb 76018a0d9ed6140ee2a639edbc821c9754a8accc
+lib/workbook/writers/json_table_writer.rb 5b3f503afd1a1a5dd410ba12f66ad66711621cb2
+lib/workbook/modules/raw_objects_storage.rb edc0d117f776f1d05c81bdd0fe7c22bdee247596

.yardoc/object_types

@@ -3,14 +3,26 @@
 
 module Workbook
   # Format is an object used for maintinaing a cell's formatting. It can belong to many cells. It maintains a relation to the raw template's equivalent, to preserve attributes Workbook cannot modify/access.
+  # The keys in the Hash are intended to closely mimick the CSS-style options:
+  #
+  #     {
+  #       background_color: '#ff000',
+  #       color: '#ffff00',
+  #       font_weight: :bold,
+  #       text_decoration: :underline,
+  #     }
+  #
+  # Note that as we speak, not all exporters support all properties properly. Consider it WIP.
   class Format < Hash
     include Workbook::Modules::RawObjectsStorage
     alias_method :merge_hash, :merge
     alias_method :merge_hash!, :merge!
     attr_accessor :name, :parent
 
-    # Initialize
+    # Initializes Workbook::Format with a hash. The keys in the Hash are intended to closely mimick the CSS-style options (see above)
+    #
     # @param [Workbook::Format, Hash] options (e.g. :background, :color, :background_color, :font_weight (integer or css-type labels)
+    # @return [String] the name of the format, default: nil
     def initialize options={}, name=nil
       options.each {|k,v| self[k]=v}
       self.name = name

.yardoc/objects/root.dat

@@ -102,7 +102,7 @@ def template
 
       # Change the current format
       #
-      # @param [Workbook::Format, Hash] f set the formatting properties of this Cell
+      # @param [Workbook::Format, Hash] f set the formatting properties of this Cell, see Workbook::Format#initialize
       def format= f
         if f.is_a? Workbook::Format
           @workbook_format = f
@@ -115,7 +115,7 @@ def format= f
 
       # Returns current format
       #
-      # @returns [Workbook::Format] the current format
+      # @return [Workbook::Format] the current format
       def format
         # return @workbook_format if @workbook_format
         if row and template and row.header? and !@workbook_format
@@ -211,8 +211,9 @@ def to_sym
       end
 
       # Compare
+      #
       # @param [Workbook::Cell] other cell to compare against (based on value), can compare different value-types using #compare_on_class
-      # @returns [Fixnum] -1, 0, 1
+      # @return [Fixnum] -1, 0, 1
       def <=> other
         rv = nil
         begin
@@ -224,7 +225,6 @@ def <=> other
           rv = compare_on_class other
         end
         return rv
-
       end
 
       # Compare on class level
@@ -248,20 +248,23 @@ def importance_of_class value
         return nil
       end
 
+      # Returns whether special formatting is present on this cell
+      #
+      # @return [Boolean] index of the cell
       def format?
         format and format.keys.count > 0
       end
 
       # Returns the index of the cell within the row, returns nil if no row is present
       #
-      # @returns [Integer, NilClass] index of the cell
+      # @return [Integer, NilClass] index of the cell
       def index
         row.index self if row
       end
 
       # Returns the key (a Symbol) of the cell, based on its table's header
       #
-      # @returns [Symbol, NilClass] key of the cell, returns nil if the cell doesn't belong to a table
+      # @return [Symbol, NilClass] key of the cell, returns nil if the cell doesn't belong to a table
       def key
         table.header[index].to_sym if table
       end

lib/workbook/format.rb

@@ -28,7 +28,7 @@ def remove_all_raws!
       end
 
       # Lists the classes for which raws are available
-      # @return Array<Object> array with the classes available
+      # @return [Array<Object>] array with the classes available
       def available_raws
         raws.keys
       end

lib/workbook/modules/cell.rb

@@ -4,7 +4,7 @@ module Workbook
   class NilValue
 
     # initialize this special nilvalue with a reason
-    # @params [String] reason (currently only :covered, in case this cell is coverd because an adjecant cell spans over it)
+    # @param [String] reason (currently only :covered, in case this cell is coverd because an adjecant cell spans over it)
     def initialize reason
       self.reason= reason
     end

lib/workbook/modules/raw_objects_storage.rb

@@ -5,7 +5,7 @@ module XlsShared
 
       # Converts standard (ruby/C++/unix/...) strftime formatting to MS's formatting
       #
-      # @param [String, nil] numberformat (nil returns nil)
+      # @param [String, nil] ms_nr_format (nil returns nil)
       # @return [String, nil]
       def ms_formatting_to_strftime ms_nr_format
         if ms_nr_format

lib/workbook/nil_value.rb

@@ -36,7 +36,7 @@ def table
 
     # Returns the name of this sheet
     #
-    # @return [String] the name, defaulting to "Sheet {index}" when none is set
+    # @return [String] the name, defaulting to sheet#index when none is set
     def name
       @name ||= "Sheet #{book.index(self)+1}"
     end

lib/workbook/readers/xls_shared.rb

@@ -55,7 +55,7 @@ def header
     # Set the header of this table (typically the first row, but can be a different row).
     # The header row is also used for finding values in a aribrary row.
     #
-    # @param [Workbook::Row, Integer]
+    # @param [Workbook::Row, Integer] h should be the row or the index of this table's row
     # @return [Workbook::Row] The header
     def header= h
       if h.is_a? Numeric
@@ -65,8 +65,11 @@ def header= h
       end
     end
 
-    def header_row_index(h=nil)
-      self.index(h ? h : self.header)
+    # Returns the index of the header row
+    #
+    # @return [Integer] The index of the header row (typically 0)
+    def header_row_index
+      self.index(self.header)
     end
 
     def define_columns_with_row(r)
@@ -76,6 +79,9 @@ def define_columns_with_row(r)
     end
 
     # Generates a new row, with optionally predefined cell-values, that is already connected to this table.
+    #
+    # @param [Array, Workbook::Row] cell_values is an array or row of cell values
+    # @return [Workbook::Row] the newly created row
     def new_row cell_values=[]
       r = Workbook::Row.new(cell_values,self)
       return r

lib/workbook/sheet.rb

@@ -6,7 +6,6 @@ module Writers
     module CsvTableWriter
       # Output the current workbook to CSV format
       #
-      # @param [String] filename
       # @param [Hash] options (not used)
       # @return [String] csv (comma separated values in a string)
       def to_csv options={}
@@ -23,7 +22,7 @@ def to_csv options={}
         end
         csv
       end
-      
+
       # Write the current workbook to CSV format
       #
       # @param [String] filename

lib/workbook/table.rb

@@ -89,11 +89,12 @@ def formats_to_xlsx_format
         end
       end
 
+      def make_sure_f_is_a_workbook_format f
+        f.is_a?(Workbook::Format) ? f : Workbook::Format.new(f)
+      end
+
       def format_to_xlsx_format f
-        xlsfmt = nil
-        unless f.is_a? Workbook::Format
-          f = Workbook::Format.new f
-        end
+        f = make_sure_f_is_a_workbook_format f
 
         xlsfmt={}
         xlsfmt[:fg_color] = "FF#{f[:color].to_s.upcase}".gsub("#",'') if f[:color]
@@ -104,10 +105,10 @@ def format_to_xlsx_format f
         xlsfmt[:format_code] = strftime_to_ms_format(f[:number_format]) if f[:number_format]
         xlsfmt[:font_name] = f[:font_family].split.first if f[:font_family]
         xlsfmt[:family] = parse_font_family(f) if f[:font_family]
-        f.add_raw init_xlsx_spreadsheet_template.workbook.styles.add_style(xlsfmt)
-        # wb.styles{|a| p a.add_style({}).class }
 
+        f.add_raw init_xlsx_spreadsheet_template.workbook.styles.add_style(xlsfmt)
         f.add_raw xlsfmt
+
         return xlsfmt
       end
     end