From 13103aecb26ae819741fa22492428bb35ba33365 Mon Sep 17 00:00:00 2001
From: Paris <paris@sourcelair.com>
Date: Tue, 24 Feb 2015 22:28:47 +0200
Subject: [PATCH] [attach addon] Document with JSDoc

---
 addons/attach/attach.js | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/addons/attach/attach.js b/addons/attach/attach.js
index c12b5135..5d74b17c 100644
--- a/addons/attach/attach.js
+++ b/addons/attach/attach.js
@@ -19,6 +19,16 @@
         attach(this.Xterm);
     }
 })(function (Xterm) {
+    /**
+     * Attaches the current terminal to the given socket
+     *
+     * @param {WebSocket} socket - The socket to attach the current terminal
+     * @param {boolean} bidirectional - Whether the terminal should send data
+     *                                  to the socket as well
+     * @param {boolean} buffered - Whether the rendering of incoming data
+     *                             should happen instantly or at a maximum
+     *                             frequency of 1 rendering per 10ms
+     */
     Xterm.prototype.attach = function (socket, bidirectional, buffered) {
         var term = this;
 
@@ -63,6 +73,12 @@
         socket.addEventListener('error', term.detach.bind(term, socket));
     };
 
+    /**
+     * Detaches the current terminal from the given socket
+     *
+     * @param {WebSocket} socket - The socket from which to detach the current
+     *                             terminal
+     */
     Xterm.prototype.detach = function (socket) {
         var term = this;