Update documentation with cleaner license declaration

[mirror_xterm.js.git] / src / addons / fullscreen / fullscreen.js

diff --git a/src/addons/fullscreen/fullscreen.js b/src/addons/fullscreen/fullscreen.js
index e4098f48a4b3ced979d0b2c360ecaa5cd6b6061e..e8e34ea3947a5cc8531af3b13598723191ca1bcd 100644 (file)
--- a/src/addons/fullscreen/fullscreen.js
+++ b/src/addons/fullscreen/fullscreen.js
@@ -1,14 +1,7 @@
-/*
+/**
  * Fullscreen addon for xterm.js
- *
- * Implements the toggleFullscreen function.
- *
- * If the `fullscreen` argument has been supplied, then
- * if it is true, the fullscreen mode gets turned on,
- * if it is false or null, the fullscreen mode gets turned off.
- *
- * If the `fullscreen` argument has not been supplied, the
- * fullscreen mode is being toggled.
+ * @module xterm/addons/fullscreen/fullscreen
+ * @license MIT
  */
 (function (fullscreen) {
   if (typeof exports === 'object' && typeof module === 'object') {
@@ -30,6 +23,11 @@
 })(function (Xterm) {
   var exports = {};
 
+  /**
+   * Toggle the given terminal's fullscreen mode.
+   * @param {Xterm} term - The terminal to toggle full screen mode
+   * @param {boolean} fullscreen - Toggle fullscreen on (true) or off (false)
+   */
   exports.toggleFullScreen = function (term, fullscreen) {
     var fn;