From 2ace9385a27d77e3fbf1f987b3bf3f0ce6af7ebc Mon Sep 17 00:00:00 2001
From: Nick Couchman <vnick@apache.org>
Date: Thu, 22 Feb 2018 20:10:16 -0500
Subject: [PATCH] GUACAMOLE-269: Add documentation for the defines and
 variables.

---
 src/protocols/ssh/ttymode.h | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/src/protocols/ssh/ttymode.h b/src/protocols/ssh/ttymode.h
index 524051e6..e1a0101f 100644
--- a/src/protocols/ssh/ttymode.h
+++ b/src/protocols/ssh/ttymode.h
@@ -22,11 +22,31 @@
 
 #include "config.h"
 
+/**
+ * The SSH TTY mode encoding opcode that terminates
+ * the list of TTY modes.
+ */
 #define GUAC_SSH_TTY_OP_END 0
+
+/**
+ * The SSH tty mode encoding opcode that configures
+ * the TTY erase code to configure the server
+ * backspace key.
+ */
 #define GUAC_SSH_TTY_OP_VERASE 3
 
+/**
+ * The default ASCII code to send for the backspace
+ * key that will be sent to the SSH server.
+ */
 #define GUAC_SSH_TERM_DEFAULT_BACKSPACE 127
 
+/**
+ * The array of TTY mode encoding data to send to the
+ * SSH server.  These consist of pairs of byte codes
+ * and uint32 (4-byte) values, with a 0 to terminate
+ * the list.
+ */
 extern const char GUAC_SSH_TTY_MODES[6];
 
 #endif