lib/platformx/text.rb in platformx-0.0.7 vs lib/platformx/text.rb in platformx-0.0.8

@@ -1,19 +1,24 @@
 module Platformx
+  # Text helpers module
+  # @author Tim Mushen
 	module TextHelpers
-########################################################
-#
-# Start Helpers
-#
-########################################################
 
-# Slug
+# Generates slug from text
+# @param slug [String] text to slug
+# @return [String] slugged text
 def x_slug(slug: "")
   return slug.slugify
 end
 
-#x_boolean_label
+# Generate boolean label
+# @param value [Boolean] boolean value
+# @param type [String] boolean label type
+# @return [String] boolean label (yes or no for boolean value)
+# @example
+#   x_boolean_label(true) # -> "Yes"
+#   x_boolean_label(false) # -> "No"
 def x_boolean_label(value: "", type: "text")
 
 	if !value.nil? && value == true
 		str = "Yes"
 	else
@@ -21,12 +26,8 @@
 	end
 	
 	return str
 
 end
-########################################################
-#
-# End
-#
-########################################################
+
   end
-end
\ No newline at end of file
+end