updating docs

5 files changed, 11 insertions, 5 deletions

diff --git a/lib/axlsx/drawing/num_data_source.rb b/lib/axlsx/drawing/num_data_source.rb
index 60628883..b06fdf91 100644
--- a/lib/axlsx/drawing/num_data_source.rb
+++ b/lib/axlsx/drawing/num_data_source.rb
@@ -1,4 +1,5 @@
 module Axlsx
+
   # A numeric data source for use by charts.
   class NumDataSource
 
@@ -41,6 +42,8 @@ module Axlsx
       @tag_name = v
     end
 
+    # serialize the object
+    # @param [String] str
     def to_xml_string(str="")
       str << '<c:' << tag_name.to_s << '>'
       if @f
diff --git a/lib/axlsx/drawing/vml_shape.rb b/lib/axlsx/drawing/vml_shape.rb
index 64bf4398..d1aaf07e 100644
--- a/lib/axlsx/drawing/vml_shape.rb
+++ b/lib/axlsx/drawing/vml_shape.rb
@@ -90,7 +90,7 @@ module Axlsx
     # @see bottom_row
     def bottom_row=(v); Axlsx::validate_integerish(v); @bottom_row = v.to_i end
 
-    # @see_bottom_offset
+    # @see bottom_offset
     def bottom_offset=(v); Axlsx::validate_integerish(v); @bottom_offset = v.to_i end
 
     # serialize the shape to a string
diff --git a/lib/axlsx/util/constants.rb b/lib/axlsx/util/constants.rb
index 7c8c000e..0a2b5499 100644
--- a/lib/axlsx/util/constants.rb
+++ b/lib/axlsx/util/constants.rb
@@ -81,13 +81,13 @@ module Axlsx
 
   # comment rels namespace
   COMMENT_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments"
+
+  # comment relation for nil target
   COMMENT_R_NULL = "http://purl.oclc.org/ooxml/officeDocument/relationships/comments"
 
   #vml drawing relation namespace
   VML_DRAWING_R = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/vmlDrawing'
 
-
-
   # VML Drawing content type
   VML_DRAWING_CT = "application/vnd.openxmlformats-officedocument.vmlDrawing"
 
diff --git a/lib/axlsx/workbook/worksheet/comments.rb b/lib/axlsx/workbook/worksheet/comments.rb
index f140f409..0bf703f5 100644
--- a/lib/axlsx/workbook/worksheet/comments.rb
+++ b/lib/axlsx/workbook/worksheet/comments.rb
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 module Axlsx
 
+  # Comments is a collection of Comment objects for a worksheet
   class Comments < SimpleTypedList
 
     # the vml_drawing that holds the shapes for comments
@@ -46,6 +47,8 @@ module Axlsx
       @list.last
     end
 
+    # A sorted list of the unique authors in the contained comments
+    # @return [Array]
     def authors
       @list.map { |comment| comment.author.to_s }.uniq.sort
     end
diff --git a/lib/axlsx/workbook/worksheet/row.rb b/lib/axlsx/workbook/worksheet/row.rb
index 0112da75..e3b66fb9 100644
--- a/lib/axlsx/workbook/worksheet/row.rb
+++ b/lib/axlsx/workbook/worksheet/row.rb
@@ -5,7 +5,9 @@ module Axlsx
   # @see Worksheet#add_row
   class Row
 
+    # A list of serilizable attributes.
     SERIALIZABLE_ATTRIBUTES = [:hidden, :outlineLevel, :collapsed, :style]
+
     # The worksheet this row belongs to
     # @return [Worksheet]
     attr_reader :worksheet
@@ -35,10 +37,8 @@ module Axlsx
     attr_reader :style
 
     # TODO  18.3.1.73
-    # # collapsed
     # customFormat
     # # hidden
-    # # outlineLevel
     # ph
     # # s (style)
     # spans