Document slop class methods

1 files changed, 30 insertions, 0 deletions

diff --git a/lib/slop.rb b/lib/slop.rb
index 5e0c48b..dd2d09d 100644
--- a/lib/slop.rb
+++ b/lib/slop.rb
@@ -6,20 +6,50 @@ require 'slop/types'
 require 'slop/error'
 
 module Slop
+  # The current version of Slop, of course.
   VERSION = '4.0.0'
 
+  # Parse an array of options (defaults to ARGV). Accepts an
+  # optional hash of configuration options and block.
+  #
+  # Example:
+  #
+  #   opts = Slop.parse(["-host", "localhost"]) do |o|
+  #     o.string '-host', 'a hostname', default: '0.0.0.0'
+  #   end
+  #   opts.to_hash #=> { host: 'localhost' }
+  #
+  # Returns a Slop::Result.
   def self.parse(items = ARGV, **config, &block)
     Options.new(config, &block).parse(items)
   end
 
+  # Example:
+  #
+  #   Slop.option_defined?(:string) #=> true
+  #   Slop.option_defined?(:omg)    #=> false
+  #
+  # Returns true if an option is defined.
   def self.option_defined?(name)
     const_defined?(string_to_option(name.to_s))
   end
 
+  # Example:
+  #
+  #   Slop.string_to_option("string")     #=> "StringOption"
+  #   Slop.string_to_option("some_thing") #=> "SomeThingOption"
+  #
+  # Returns a camel-cased class looking string with Option suffix.
   def self.string_to_option(s)
     s.gsub(/(?:^|_)([a-z])/) { $1.capitalize } + "Option"
   end
 
+  # Example:
+  #
+  #   Slop.string_to_option_class("string") #=> Slop::StringOption
+  #   Slop.string_to_option_class("foo")    #=> uninitialized constant FooOption
+  #
+  # Returns the full qualified option class. Uses `#string_to_option`.
   def self.string_to_option_class(s)
     const_get(string_to_option(s))
   end