diff options
author | Murray Cumming <murrayc@murrayc.com> | 2015-02-09 09:58:07 +0100 |
---|---|---|
committer | Murray Cumming <murrayc@murrayc.com> | 2015-02-09 09:58:07 +0100 |
commit | 0cfe1b6f779aad7f5e9416cc21c204c93bca6bff (patch) | |
tree | 8c59f490f76021a640cb05d102c1846d9dbca4d1 /gio/src/tcpwrapperconnection.hg | |
parent | 09de63af427ec0b9f3968d66ac3b8a89fa42eeef (diff) | |
download | glibmm-0cfe1b6f779aad7f5e9416cc21c204c93bca6bff.tar.gz |
Gio: TcpWrapperConnection: Add documentation.
Based on the C documentation.
Diffstat (limited to 'gio/src/tcpwrapperconnection.hg')
-rw-r--r-- | 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 e5e214f9..1e1a943a 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 |