Merge pull request #115 from webdoc-labs/feature/es5-class

Feature: Proper ES5 class support with inference

Author: ShukantPal

.idea/misc.xml

@@ -28,7 +28,17 @@
 					"type": "ClassDoc",
 					"scope": "static",
 					"brief": "",
-					"description": ""
+					"description": "",
+					"members": [
+						{
+							"name": "constructor",
+							"type": "MethodDoc",
+							"access": "public",
+							"scope": "instance",
+							"brief": "",
+							"description": ""
+						}
+					]
 				},
 				{
 					"name": "AbstractRenderer",
@@ -42,6 +52,14 @@
 							"scope": "instance",
 							"brief": "<p>The background color to fill if not transparent</p>",
 							"description": ""
+						},
+						{
+							"name": "constructor",
+							"type": "MethodDoc",
+							"access": "public",
+							"scope": "instance",
+							"brief": "",
+							"description": ""
 						}
 					]
 				},
@@ -475,13 +493,17 @@
 					"name": "Road",
 					"type": "ClassDoc",
 					"brief": "<p>This is another road class.</p>",
-					"description": ""
-				},
-				{
-					"name": "Road",
-					"type": "ClassDoc",
-					"brief": "<p>Road represents a drivable 2D path for vehicles.</p>",
-					"description": ""
+					"description": "",
+					"members": [
+						{
+							"name": "constructor",
+							"type": "MethodDoc",
+							"access": "public",
+							"scope": "instance",
+							"brief": "<p>This is another road class.</p>",
+							"description": ""
+						}
+					]
 				},
 				{
 					"name": "DEFAULT_LANES",
@@ -509,7 +531,17 @@
 					"name": "Transaction",
 					"type": "ClassDoc",
 					"brief": "",
-					"description": ""
+					"description": "",
+					"members": [
+						{
+							"name": "constructor",
+							"type": "MethodDoc",
+							"access": "public",
+							"scope": "instance",
+							"brief": "",
+							"description": ""
+						}
+					]
 				}
 			]
 		},
@@ -519,6 +551,14 @@
 			"brief": "<p>Bean class</p>",
 			"description": "",
 			"members": [
+				{
+					"name": "constructor",
+					"type": "MethodDoc",
+					"access": "public",
+					"scope": "instance",
+					"brief": "<p>Bean class</p>",
+					"description": ""
+				},
 				{
 					"name": "roast",
 					"type": "MethodDoc",
@@ -590,6 +630,14 @@
 					"brief": "<p>Register a retail dealer for buying a car from</p>",
 					"description": ""
 				},
+				{
+					"name": "constructor",
+					"type": "MethodDoc",
+					"access": "public",
+					"scope": "instance",
+					"brief": "<p><em>Simulation</em> for a automobile that can drive on a manifold surface.</p>",
+					"description": ""
+				},
 				{
 					"name": "onCrash",
 					"type": "MethodDoc",
@@ -635,12 +683,56 @@
 				}
 			]
 		},
+		{
+			"name": "ExampleFactory",
+			"type": "ClassDoc",
+			"description": "<p>{@link ExampleFactory} can be used to build examples.</p>\n<pre><code class=\"hljs language-js\"><span class=\"hljs-comment\">// <span class=\"hljs-doctag\">TODO:</span> Make the API interesting</span>\nExampleFactory.getInstance()\n .build()\n</code></pre>",
+			"members": [
+				{
+					"name": "getInstance",
+					"type": "MethodDoc",
+					"scope": "static",
+					"brief": "<p>Gets a lazily-initialized, shared singleton instance of {@link ExampleFactory}.</p>",
+					"description": ""
+				},
+				{
+					"name": "build",
+					"type": "MethodDoc",
+					"scope": "instance",
+					"brief": "<p>Build the road.</p>",
+					"description": ""
+				},
+				{
+					"name": "constructor",
+					"type": "MethodDoc",
+					"access": "public",
+					"scope": "instance",
+					"brief": "<p>This constructor should only be used for custom contexts.</p>",
+					"description": ""
+				},
+				{
+					"name": "getContext",
+					"type": "MethodDoc",
+					"scope": "instance",
+					"brief": "<p>Get the context of this factory.</p>",
+					"description": ""
+				}
+			]
+		},
 		{
 			"name": "Gravity",
 			"type": "ClassDoc",
 			"brief": "<p>This class shouldn't be documented!</p>",
 			"description": "",
 			"members": [
+				{
+					"name": "constructor",
+					"type": "MethodDoc",
+					"access": "public",
+					"scope": "instance",
+					"brief": "<p>This class shouldn't be documented!</p>",
+					"description": ""
+				},
 				{
 					"name": "force",
 					"type": "MethodDoc",

example/example.api.json

@@ -23,7 +23,7 @@
   },
   "scripts": {
     "unit-test": "",
-    "build": "webdoc --tutorials ./tutorials --site-root example-documentation --site-domain https://webdoc-labs.github.io",
+    "build": "webdoc --tutorials ./tutorials --site-domain https://webdoc-labs.github.io",
     "build-next": "cd .. && webdoc && cd example",
     "build-pixi-api": "cd ../../pixi-api && webdoc && cd ../webdoc/example",
     "build-pixi-api-prod": "cd ../../pixi-api && webdoc --site-root pixi-api && cd ../webdoc/example",

example/package.json

@@ -0,0 +1,69 @@
+/**
+ * A namespace dedicated to road manipulation utilites.
+ *
+ * @namespace
+ */
+const R = {
+  /**
+   * Builds a road
+   *
+   * @param {string} address
+   * @return {ExampleFactory}
+   */
+  buildRoad(address) {
+    return null;
+  },
+
+  /**
+   * The default no. of lanes per one side of road
+   */
+  DEFAULT_LANES: 4,
+};
+
+/**
+ * This constructor should only be used for custom contexts.
+ *
+ * @classdesc
+ * {@link ExampleFactory} can be used to build examples.
+ *
+ * ```js
+ * // TODO: Make the API interesting
+ * ExampleFactory.getInstance()
+ *  .build()
+ * ```
+ *
+ * @param {ExampleContext}[context=null] - A custom context for the factory.
+ * @class
+ */
+export function ExampleFactory(context= null) {
+
+}
+
+/**
+ * Get the context of this factory.
+ *
+ * @return {ExampleContext}
+ */
+ExampleFactory.prototype.getContext = function() {
+  return null;
+}
+
+/**
+ * Build the road.
+ */
+ExampleFactory.prototype.build = function() {
+
+}
+
+/**
+ * Gets a lazily-initialized, shared singleton instance of {@link ExampleFactory}.
+ *
+ * @returns {ExampleFactory}
+ */
+ExampleFactory.getInstance = function () {
+  if (!ExampleFactory.__instance) {
+    ExampleFactory.__instance = new ExampleFactory();
+  }
+
+  return ExampleFactory.__instance;
+}

example/src/ExampleFactory.js

@@ -9466,7 +9466,6 @@ function makeIds(data, collector) {
   };
 })(function Explorer(_ref2) {
   var isOpen = _ref2.isOpen,
-      setOpen = _ref2.setOpen,
       expandedItems = _ref2.expandedItems,
       setExpandedItems = _ref2.setExpandedItems,
       toggleItem = _ref2.toggleItem,
@@ -9485,9 +9484,6 @@ function makeIds(data, collector) {
   var _useExplorerStyles = useExplorerStyles(),
       root = _useExplorerStyles.root;
 
-  var toggleOpen = external_React_default.a.useCallback(function () {
-    return setOpen(!isOpen);
-  }, [isOpen]);
   var children = [];
   var explorerTree = window.appData.explorerTree;