diff options
author | Murray Cumming <murrayc@murrayc.com> | 2014-02-26 11:03:29 +0100 |
---|---|---|
committer | Murray Cumming <murrayc@murrayc.com> | 2014-02-26 11:03:29 +0100 |
commit | 3e1099c10fdefa307687d68340a08a10e65cbbb6 (patch) | |
tree | efdc3800a32a9c3ba4c1b8e8489284b4dc336956 /gio/src/socket.hg | |
parent | 62cc446507cb843a49229beaf658c76f83c8deaf (diff) | |
download | glibmm-3e1099c10fdefa307687d68340a08a10e65cbbb6.tar.gz |
Gio::Socket docs: Do not say that the Cancellable (reference) can be 0.
* gio/src/socket.hg: That makes sense only in the C API, which uses
a pointer. We instead have method overloads without that parameter.
Diffstat (limited to 'gio/src/socket.hg')
-rw-r--r-- | gio/src/socket.hg | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/gio/src/socket.hg b/gio/src/socket.hg index b5a2247b..a4f30ed6 100644 --- a/gio/src/socket.hg +++ b/gio/src/socket.hg @@ -100,7 +100,8 @@ protected: public: _WRAP_METHOD_DOCS_ONLY(g_socket_new) - /** @param cancellable A Cancellable, or <tt>0</tt>. + + /** @param cancellable A Cancellable object which can be used to cancel the operation. * @throw Glib::Error */ static Glib::RefPtr<Socket> @@ -113,7 +114,7 @@ public: _IGNORE(g_socket_connection_factory_create_connection) _WRAP_METHOD_DOCS_ONLY(g_socket_new_from_fd) - /** @param cancellable A Cancellable, or <tt>0</tt>. + /** @param cancellable A Cancellable object which can be used to cancel the operation. * @throw Glib::Error */ static Glib::RefPtr<Socket> create_from_fd(int fd, const Glib::RefPtr<Cancellable>& @@ -171,7 +172,7 @@ public: * I/O is enabled. To be notified of an incoming connection, wait for the * Glib::IO_IN condition. * - * @param cancellable a Gio::Cancellable or <tt>0</tt>. + * @param cancellable A Cancellable object which can be used to cancel the operation. * * @return a Gio::Socket * @@ -195,7 +196,7 @@ public: * with Socket::check_connect_result(). * * @param address a SocketAddress specifying the remote address. - * @param cancellable a Cancellable or <tt>0</tt>. + * @param cancellable A Cancellable object which can be used to cancel the operation. * * @throw Gio::Error */ |