Gaia/System/Refactoring Plan: Difference between revisions

Gaia/System/Refactoring Plan (view source)

632 bytes added , 17 February 2014

Confirmed users

401

edits

@@ Line 95: / Line 95: @@
 </pre>
 and jsdoc will be generated to 'docs' folder
+=== Sample ===
+<pre>
+'use strict';
+(function(exports) {
+  /**
+   * DESCRIPTION-OF-THIS-MODULE.
+   * @class Module
+   */
+  function Module() {
+    window.addEventListener('widget-panel-update', function updateHandler(e){
+      this.display(e.detail);
+      e.preventDefault();
+    }.bind(this));
+  }
+  Module.prototype = {
+    /**
+     * DESCRIPTION-OF-IMPORTANT-PUBLIC-API
+     * @memberof Module.prototype
+     */
+    show: function(data) {
+    },
+    /**
+     * DESCRIPTION-OF-IMPORTANT-PUBLIC-ATTRIBUTE
+     * @memberof DevtoolsView.prototype
+     */
+    state: 'begin'
+  };
+  exports.Module = Module;
+}(window));
+</pre>