[gtk-vnc] connection: document VncConnectionAuth

[Daniel P. Berrange <dberrange src gnome org>]

commit b118715c0946a8bc6e531bbaccdf25da4c382af5
Author: Marc-André Lureau <marcandre lureau gmail com>
Date:   Fri Apr 2 12:24:08 2021 +0400

    connection: document VncConnectionAuth
    
    GEnum works with values that fit in int. However 0xffffffa doesn't fit,
    it is actually -6. We can't change the assigned value as this would
    likely change the representation of the enum back to int and may break ABI.
    
    Signed-off-by: Marc-André Lureau <marcandre lureau redhat com>

 src/vncconnection.h | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)
---
diff --git a/src/vncconnection.h b/src/vncconnection.h
index dc250f7..fc2fc64 100644
--- a/src/vncconnection.h
+++ b/src/vncconnection.h
@@ -133,6 +133,22 @@ typedef enum {
     VNC_CONNECTION_ENCODING_ALPHA_CURSOR = -314,
 } VncConnectionEncoding;
 
+/**
+ * VncConnectionAuth:
+ * @VNC_CONNECTION_AUTH_INVALID:
+ * @VNC_CONNECTION_AUTH_NONE: No authentication is needed and protocol data is to be sent unencrypted.
+ * @VNC_CONNECTION_AUTH_VNC: VNC authentication is to be used and protocol data is to be sent unencrypted.
+ * @VNC_CONNECTION_AUTH_RA2: RealVNC authentication.
+ * @VNC_CONNECTION_AUTH_RA2NE: RealVNC authentication.
+ * @VNC_CONNECTION_AUTH_TIGHT: The Tight security type is a generic protocol extension.
+ * @VNC_CONNECTION_AUTH_ULTRA: Ultra authentication.
+ * @VNC_CONNECTION_AUTH_TLS: TLS authentication.
+ * @VNC_CONNECTION_AUTH_VENCRYPT: The VeNCrypt security type is a generic authentication method which 
encapsulates multiple authentication subtypes.
+ * @VNC_CONNECTION_AUTH_SASL: SASL authentication.
+ * @VNC_CONNECTION_AUTH_ARD: Apple remote desktop (screen sharing) authentication.
+ * @VNC_CONNECTION_AUTH_MSLOGONII: Authentication used by UltraVNC.
+ * @VNC_CONNECTION_AUTH_MSLOGON: Authentication used by UltraVNC.
+ */
 typedef enum {
     VNC_CONNECTION_AUTH_INVALID = 0,
     VNC_CONNECTION_AUTH_NONE = 1,
@@ -146,7 +162,7 @@ typedef enum {
     VNC_CONNECTION_AUTH_SASL = 20, /* SASL type used by VINO and QEMU */
     VNC_CONNECTION_AUTH_ARD = 30, /* Apple remote desktop (screen sharing) */
     VNC_CONNECTION_AUTH_MSLOGONII = 0x71, /* Used by UltraVNC */
-    VNC_CONNECTION_AUTH_MSLOGON = 0xfffffffa, /* Used by UltraVNC */
+    VNC_CONNECTION_AUTH_MSLOGON = 0xfffffffa, /* (aka 250 when converted to U8), Used by UltraVNC */
 } VncConnectionAuth;
 
 typedef enum {