Document known guard options.

2011-10-11 11:09:41 +02:00 · 2011-10-11 11:09:41 +02:00 · f6bea4da59
commit f6bea4da59
parent 8527cf40e3
1 changed files with 2 additions and 0 deletions
--- a/lib/guard/guard.rb
+++ b/lib/guard/guard.rb
@ -38,6 +38,8 @@ module Guard
    #
    # @param [Array<Guard::Watcher>] watchers the Guard file watchers
    # @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 = {})
      @group = options[:group] ? options.delete(:group).to_sym : :default