Document known guard options.

This commit is contained in:
Michael Kessler 2011-10-11 11:09:41 +02:00
parent 8527cf40e3
commit f6bea4da59

View File

@ -38,6 +38,8 @@ module Guard
# #
# @param [Array<Guard::Watcher>] watchers the Guard file watchers # @param [Array<Guard::Watcher>] watchers the Guard file watchers
# @param [Hash] options the custom Guard options # @param [Hash] options the custom Guard options
# @options [Symbol] group the group this Guard belongs to
# @options [Boolean] any_return allow any object to be returned from a watcher
# #
def initialize(watchers = [], options = {}) def initialize(watchers = [], options = {})
@group = options[:group] ? options.delete(:group).to_sym : :default @group = options[:group] ? options.delete(:group).to_sym : :default