[glib-networking] Improve comments



commit 6e84378392696c8780addfc8b9c958cb6917a81a
Author: Michael Catanzaro <mcatanzaro igalia com>
Date:   Wed Feb 28 18:31:27 2018 -0600

    Improve comments

 tls/gnutls/gtlsconnection-gnutls.c |   14 ++++++++++----
 1 files changed, 10 insertions(+), 4 deletions(-)
---
diff --git a/tls/gnutls/gtlsconnection-gnutls.c b/tls/gnutls/gtlsconnection-gnutls.c
index 3ab1ee7..e5b8fca 100644
--- a/tls/gnutls/gtlsconnection-gnutls.c
+++ b/tls/gnutls/gtlsconnection-gnutls.c
@@ -144,8 +144,14 @@ enum
 
 typedef struct
 {
-  /* When operating in stream mode.
-   * Mutually exclusive with base_socket.
+  /* When operating in stream mode, as a GTlsConnection. These are
+   * mutually-exclusive with base_socket. There are two different
+   * GIOStreams here: base_io_stream and GTlsConnectionGnutls itself.
+   * base_io_stream is the GIOStream used to create the GTlsConnection,
+   * and corresponds to the GTlsConnection::base-io-stream property.
+   * base_istream and base_ostream correspond to the GIOStream::input-stream
+   * and GIOStream::output-stream properties, respectively, that
+   * GTlsConnection inherits from GIOStream.
    */
   GIOStream *base_io_stream;
   GPollableInputStream *base_istream;
@@ -158,8 +164,8 @@ typedef struct
   GInputStream *tls_istream;
   GOutputStream *tls_ostream;
 
-  /* When operating in datagram mode.
-   * Mutually exclusive with base_io_stream.
+  /* When operating in datagram mode, as a GDtlsConnection. These are
+   * mutually-exclusive with base_io_stream.
    */
   GDatagramBased *base_socket;
 


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