Skip to content

Commit

Permalink
Fix documentation for ObjectProxy::ConnectToSignal()
Browse files Browse the repository at this point in the history
The documentation for ObjectProxy::ConnectToSignal() differs
from the method's actual behavior. Fix this, by updating
the documentation.

BUG=545139
R=hashimoto@chromium.org
TEST=compile

Review URL: https://codereview.chromium.org/1406923005

Cr-Commit-Position: refs/heads/master@{#355785}
  • Loading branch information
quiche authored and Commit bot committed Oct 23, 2015
1 parent b691110 commit b270236
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions dbus/object_proxy.h
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,7 @@ class CHROME_DBUS_EXPORT ObjectProxy
ResponseCallback callback,
ErrorCallback error_callback);

// Requests to connect to the signal from the remote object, replacing
// any previous |signal_callback| connected to that signal.
// Requests to connect to the signal from the remote object.
//
// |signal_callback| will be called in the origin thread, when the
// signal is received from the remote object. As it's called in the
Expand All @@ -157,6 +156,11 @@ class CHROME_DBUS_EXPORT ObjectProxy
// |on_connected_callback| is called when the object proxy is connected
// to the signal, or failed to be connected, in the origin thread.
//
// If a SignalCallback has already been registered for the given
// |interface_name| and |signal_name|, |signal_callback| will be
// added to the list of callbacks for |interface_name| and
// |signal_name|.
//
// Must be called in the origin thread.
virtual void ConnectToSignal(const std::string& interface_name,
const std::string& signal_name,
Expand Down

0 comments on commit b270236

Please sign in to comment.