From cef93d7501cd25615a4dfc1d1b143fbe7babfbd5 Mon Sep 17 00:00:00 2001
From: Randy Morgan <digital.ipseity@gmail.com>
Date: Mon, 9 Sep 2013 10:31:06 +0900
Subject: docs for ColBreaks

---
 lib/axlsx/workbook/worksheet/col_breaks.rb | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'lib')

diff --git a/lib/axlsx/workbook/worksheet/col_breaks.rb b/lib/axlsx/workbook/worksheet/col_breaks.rb
index 2bf927e1..a519ba5f 100644
--- a/lib/axlsx/workbook/worksheet/col_breaks.rb
+++ b/lib/axlsx/workbook/worksheet/col_breaks.rb
@@ -1,16 +1,27 @@
 module Axlsx
 
+  # A collection of Brake objects.
+  # Please do not use this class directly. Instead use 
+  # Worksheet#add_break
   class ColBreaks < SimpleTypedList
 
+    # Instantiates a new list restricted to Break types
     def initialize
       super Break
     end
 
+    # A column break specific helper for adding a break.
+    # @param [Hash] options A list of options to pass into the Break object
+    # The max and man options are fixed, however any other valid option for 
+    # Break will be passed to the created break object.
+    # @see Break
     def add_break(options)
       options.merge max: 1048575, man: true
       @list << Break.new(options)
     end
 
+    # Serialize the collection to xml
+    # @param [String] str The string to append this lists xml to.
     def to_xml_string(str='')
       return if empty?
       str << '<colBreaks count="' << @list.size << '" manualBreakCount="' << @list.size << '">'
-- 
cgit v1.2.3