Skip to content
Browse files

doc: no need to mention an irregularity with on_signal; fixes #31.

amended the linked method doc not to specify a return value
  • Loading branch information...
1 parent 95af5bb commit 5ea58ff8f4f9dd117e3b2b51dc4894a256eae715 @mvidner committed Nov 6, 2012
Showing with 3 additions and 2 deletions.
  1. +1 −2 doc/Reference.md
  2. +2 −0 lib/dbus/introspect.rb
View
3 doc/Reference.md
@@ -86,9 +86,8 @@ Alternately, run the GLib main loop and add your DBus connections to it via
#### Receiving Signals
To receive signals for a specific object and interface, use
-{DBus::ProxyObjectInterface#on\_signal}(bus, name, &block) or
+{DBus::ProxyObjectInterface#on\_signal}(name, &block) or
{DBus::ProxyObject#on_signal}(name, &block), for the default interface.
-([I#31](https://github.com/mvidner/ruby-dbus/issues/31))
{include:file:doc/ex-signal.body.rb}
View
2 lib/dbus/introspect.rb
@@ -305,6 +305,7 @@ def define_method(methodname, prototype)
# over the given _bus_. If no block is given, the signal is unregistered.
# Note that specifying _bus_ is discouraged and the option is kept only for
# backward compatibility.
+ # @return [void]
def on_signal(*args, &block)
# Since we must function under ruby 1.8.7, it isn't possible to define the
# function as on_signal(bus = nil, name, &block)
@@ -448,6 +449,7 @@ def has_iface?(name)
# Registers a handler, the code block, for a signal with the given _name_.
# It uses _default_iface_ which must have been set.
+ # @return [void]
def on_signal(name, &block)
if @default_iface and has_iface?(@default_iface)
@interfaces[@default_iface].on_signal(name, &block)

0 comments on commit 5ea58ff

Please sign in to comment.
Something went wrong with that request. Please try again.