lib/ceedling/reportinator.rb in ceedling-0.27.0 vs lib/ceedling/reportinator.rb in ceedling-0.28.1

@@ -1,7 +1,24 @@
-
+##
+# Pretifies reports
 class Reportinator
 
+  ##
+  # Generates a banner for a message based on the length of the message or a
+  # given width.
+  # ==== Attributes
+  #
+  # * _message_:  The message to put.
+  # * _width_:    The width of the message. If nil the size of the banner is
+  # determined by the length of the message.
+  #
+  # ==== Examples
+  #
+  #    rp = Reportinator.new
+  #    rp.generate_banner("Hello world!") => "------------\nHello world!\n------------\n" 
+  #    rp.generate_banner("Hello world!", 3) => "---\nHello world!\n---\n" 
+  #
+  #
   def generate_banner(message, width=nil)
     dash_count = ((width.nil?) ? message.strip.length : width)
     return "#{'-' * dash_count}\n#{message}\n#{'-' * dash_count}\n"
   end