[glibmm] Gio: TcpWrapperConnection: Add documentation.



commit 0cfe1b6f779aad7f5e9416cc21c204c93bca6bff
Author: Murray Cumming <murrayc murrayc com>
Date:   Mon Feb 9 09:58:07 2015 +0100

    Gio: TcpWrapperConnection: Add documentation.
    
    Based on the C documentation.

 gio/src/tcpwrapperconnection.hg |    9 +++++++--
 1 files changed, 7 insertions(+), 2 deletions(-)
---
diff --git a/gio/src/tcpwrapperconnection.hg b/gio/src/tcpwrapperconnection.hg
index e5e214f..1e1a943 100644
--- a/gio/src/tcpwrapperconnection.hg
+++ b/gio/src/tcpwrapperconnection.hg
@@ -23,8 +23,13 @@ _PINCLUDE(giomm/private/tcpconnection_p.h)
 namespace Gio
 {
 
-/**
- * TODO
+/** Wrapper for non-Gio::SocketConnection-based, Gio::Socket-based Gio::IOStreams.
+ *
+ * This can be used to wrap a Gio::Stream that is
+ * based on a Gio::Socket, but which is not actually a
+ * Gio::SocketConnection. This is used by Gio::SocketClient so that it can
+ * always return a Gio::SocketConnection, even when the connection it has
+ * actually created is not directly a Gio::SocketConnection.
  *
  * @newin{2,34}
  * @ingroup NetworkIO


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