JSdoc

js/widgets/temperament.js

@@ -1,13 +1,25 @@
-// Copyright (c) 2018 Riya Lohia
-//
-// This program is free software; you can redistribute it and/or
-// modify it under the terms of the The GNU Affero General Public
-// License as published by the Free Software Foundation; either
-// version 3 of the License, or (at your option) any later version.
-//
-// You should have received a copy of the GNU Affero General Public
-// License along with this library; if not, write to the Free Software
-// Foundation, 51 Franklin Street, Suite 500 Boston, MA 02110-1335 USA
+/**
+ * @file This contains the prototype of the JavaScript Editor Widget.
+ * @author Riya Lohia
+ *
+ * @copyright 2018 Riya Lohia
+ *
+ * @license
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * The GNU Affero General Public License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with this
+ * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
+ * MA 02110-1335 USA.
+*/
+
+/**
+ * @class
+ * @classdesc pertains to setting up all features of the temperament widget and its UI features.
+ *
+ * Private members' names begin with underscore '_".
+ */
 
 const temperamentTableDiv = document.createElement("div");
 let temperamentCell = null;
@@ -18,6 +30,9 @@ class TemperamentWidget {
     static INNERWINDOWWIDTH = 600;
     static BUTTONSIZE = 53;
     static ICONSIZE = 32;
+    /**
+     * @constructor
+     */
     constructor(){
         this.inTemperament = null;
         this.lastTriggered = null;
@@ -69,7 +84,10 @@ class TemperamentWidget {
 
         return cell;
     };
-
+/**
+     * Renders the circle of notes UI and all the subcomponents in the DOM widget.
+     * @returns {void}
+     */
     _circleOfNotes () {
         this.circleIsVisible = false;
         this.toggleNotesButton();