Method: Filigree::Configuration::ClassMethods#usage

Defined in:
lib/filigree/configuration.rb

#usage(str = nil) ⇒ String

Add’s a usage string to the entire configuration object. If no string is provided the current usage string is returned.

Parameters:

  • str (String, nil) (defaults to: nil)

    Usage string

Returns:

  • (String)

    Current or new usage string



337
338
339
# File 'lib/filigree/configuration.rb', line 337

def usage(str = nil)
	if str then @usage = str else @usage end
end