documentation for comments.

1 files changed, 8 insertions, 0 deletions

diff --git a/lib/axlsx/drawing/vml_drawing.rb b/lib/axlsx/drawing/vml_drawing.rb
index 8ff6469b..2ae1dc68 100644
--- a/lib/axlsx/drawing/vml_drawing.rb
+++ b/lib/axlsx/drawing/vml_drawing.rb
@@ -1,16 +1,24 @@
 module Axlsx
 
+  # a vml drawing used for comments in excel.
   class VmlDrawing
 
+    # creates a new Vml Drawing object.
+    # @param [Comments] the comments object this drawing is associated with
     def initialize(comments)
       raise ArgumentError, "you must provide a comments object" unless comments.is_a?(Comments)
       @comments = comments
     end
 
+    # The part name for this vml drawing
+    # @return [String]
     def pn
       "#{VML_DRAWING_PN}" % (@comments.worksheet.index + 1)
     end
 
+    # serialize the vml_drawing to xml.
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str = '')
       str = <<BAD_PROGRAMMER
 <xml xmlns:v="urn:schemas-microsoft-com:vml"