[glibmm] Gio::Socket docs: Do not say that the Cancellable (reference) can be 0.



commit 3e1099c10fdefa307687d68340a08a10e65cbbb6
Author: Murray Cumming <murrayc murrayc com>
Date:   Wed Feb 26 11:03:29 2014 +0100

    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.

 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 b5a2247..a4f30ed 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
    */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]