jsdoc added

CartoDB · Nov 24, 2017 · 84dcd28 · 84dcd28
1 parent 1902105
commit 84dcd28
Show file tree

Hide file tree

Showing 9 changed files with 149 additions and 14 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 node_modules/
+docs/
diff --git a/config/jsdoc/internal.json b/config/jsdoc/internal.json
@@ -0,0 +1,20 @@
+{
+  "source": {
+    "include": [
+      "src"
+    ]
+  },
+  "templates": {
+    "default": {
+      "outputSourceFiles": false,
+      "useLongnameInNav": true
+    }
+  },
+  "plugins": [
+    "plugins/markdown"
+  ],
+  "opts": {
+    "recurse": true,
+    "destination": "./docs/internal"
+  }
+}
diff --git a/config/jsdoc/plugins/api.js b/config/jsdoc/plugins/api.js
@@ -0,0 +1,26 @@
+/**
+ * Define @api tag
+ */
+exports.defineTags = function (dictionary) {
+  dictionary.defineTag('api', {
+    mustHaveValue: false,
+    canHaveType: false,
+    canHaveName: false,
+    onTagged: function (doclet, tag) {
+      doclet.public = true;
+    }
+  });
+};
+
+/*
+ * Only items with @api annotation should be documented
+ */
+
+exports.handlers = {
+  parseComplete: function (e) {
+    var doclets = e.doclets;
+    for (var i = 0; i < doclets.length; i++) {
+      doclets[i].undocumented = !doclets[i].public;
+    }
+  }
+};
diff --git a/config/jsdoc/public.json b/config/jsdoc/public.json
@@ -0,0 +1,21 @@
+{
+  "source": {
+    "include": [
+      "src"
+    ]
+  },
+  "templates": {
+    "default": {
+      "outputSourceFiles": false,
+      "useLongnameInNav": true
+    }
+  },
+  "plugins": [
+    "plugins/api",
+    "plugins/markdown"
+  ],
+  "opts": {
+    "recurse": true,
+    "destination": "./docs/public"
+  }
+}
diff --git a/dist/gmaps.js b/dist/gmaps.js
@@ -636,6 +636,11 @@ Renderer.prototype.addTile = function (tile) {
     return tile;
 }
 
+/**
+ * THIS IS A RENDERER.
+ * @constructor
+ * @param {HTMLElement} canvas
+ */
 function Renderer(canvas) {
     this.canvas = canvas;
     this.tiles = [];
@@ -664,14 +669,21 @@ function Renderer(canvas) {
     gl.bufferData(gl.ARRAY_BUFFER, new Float32Array(vertices), gl.STATIC_DRAW);
 }
 
+/**
+ * Wadus qwuasdfdasfasd fsadfads
+ * @api Get Renderer center in Renderer coordinates
+ * @param {fff}
+ * @name Renderer#getCenter
+ */
 Renderer.prototype.getCenter = function () {
     return { x: this._center.x, y: this._center.y };
-}
+};
+
 Renderer.prototype.setCenter = function (x, y) {
     this._center.x = x;
     this._center.y = y;
     window.requestAnimationFrame(refresh.bind(this));
-}
+};
 
 Renderer.prototype.getZoom = function () {
     return this._zoom;

diff --git a/dist/mapbox.js b/dist/mapbox.js
@@ -636,6 +636,11 @@ Renderer.prototype.addTile = function (tile) {
     return tile;
 }
 
+/**
+ * THIS IS A RENDERER.
+ * @constructor
+ * @param {HTMLElement} canvas
+ */
 function Renderer(canvas) {
     this.canvas = canvas;
     this.tiles = [];
@@ -664,14 +669,21 @@ function Renderer(canvas) {
     gl.bufferData(gl.ARRAY_BUFFER, new Float32Array(vertices), gl.STATIC_DRAW);
 }
 
+/**
+ * Wadus qwuasdfdasfasd fsadfads
+ * @api Get Renderer center in Renderer coordinates
+ * @param {fff}
+ * @name Renderer#getCenter
+ */
 Renderer.prototype.getCenter = function () {
     return { x: this._center.x, y: this._center.y };
-}
+};
+
 Renderer.prototype.setCenter = function (x, y) {
     this._center.x = x;
     this._center.y = y;
     window.requestAnimationFrame(refresh.bind(this));
-}
+};
 
 Renderer.prototype.getZoom = function () {
     return this._zoom;

diff --git a/dist/standalone.js b/dist/standalone.js
@@ -636,6 +636,11 @@ Renderer.prototype.addTile = function (tile) {
     return tile;
 }
 
+/**
+ * THIS IS A RENDERER.
+ * @constructor
+ * @param {HTMLElement} canvas
+ */
 function Renderer(canvas) {
     this.canvas = canvas;
     this.tiles = [];
@@ -664,14 +669,21 @@ function Renderer(canvas) {
     gl.bufferData(gl.ARRAY_BUFFER, new Float32Array(vertices), gl.STATIC_DRAW);
 }
 
+/**
+ * Wadus qwuasdfdasfasd fsadfads
+ * @api Get Renderer center in Renderer coordinates
+ * @param {fff}
+ * @name Renderer#getCenter
+ */
 Renderer.prototype.getCenter = function () {
     return { x: this._center.x, y: this._center.y };
-}
+};
+
 Renderer.prototype.setCenter = function (x, y) {
     this._center.x = x;
     this._center.y = y;
     window.requestAnimationFrame(refresh.bind(this));
-}
+};
 
 Renderer.prototype.getZoom = function () {
     return this._zoom;

diff --git a/package.json b/package.json
@@ -5,7 +5,8 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "webpack",
-    "build:watch": "webpack -w"
+    "build:watch": "webpack -w",
+    "build-doc": "rm -rf docs/; node_modules/.bin/jsdoc --configure config/jsdoc/internal.json; node_modules/.bin/jsdoc --configure config/jsdoc/public.json"
   },
   "repository": {
     "type": "git",
@@ -24,7 +25,8 @@
   "dependencies": {
     "@mapbox/vector-tile": "^1.3.0",
     "cartocolor": "^4.0.0",
+    "jsdoc": "^3.5.5",
     "jsep": "^0.3.2",
     "pbf": "^3.1.0"
   }
-}
+}
diff --git a/src/index.js b/src/index.js
@@ -9,10 +9,6 @@ var gl;
 // they imply a small waste of resources too
 const RTT_WIDTH = 1024;
 
-Renderer.prototype._initShaders = function () {
-    this.finalRendererProgram = shaders.renderer.createPointShader(gl);
-}
-
 Renderer.prototype.refresh = refresh;
 function refresh(timestamp) {
     // Don't re-render more than once per animation frame
@@ -252,6 +248,13 @@ Renderer.prototype.addTile = function (tile) {
     return tile;
 }
 
+/**
+ * THIS IS A RENDERER.
+ * @api
+ * @memberOf renderer
+ * @constructor
+ * @param {HTMLElement} canvas - adlfkajdsf
+ */
 function Renderer(canvas) {
     this.canvas = canvas;
     this.tiles = [];
@@ -280,14 +283,40 @@ function Renderer(canvas) {
     gl.bufferData(gl.ARRAY_BUFFER, new Float32Array(vertices), gl.STATIC_DRAW);
 }
 
+/**
+ * Initialize static shaders
+ */
+Renderer.prototype._initShaders = function () {
+    this.finalRendererProgram = shaders.renderer.createPointShader(gl);
+}
+
+
+/**
+ * @api
+ * @typedef {object} RPoint
+ * @property {number} x
+ * @property {number} y
+ */
+
+/**
+ * Get Renderer visualization center
+ * @api
+ * @return {RPoint}
+ */
 Renderer.prototype.getCenter = function () {
     return { x: this._center.x, y: this._center.y };
-}
+};
+/**
+ * Set Renderer visualization center
+ * @api
+ * @param {number} x
+ * @param {number} y
+ */
 Renderer.prototype.setCenter = function (x, y) {
     this._center.x = x;
     this._center.y = y;
     window.requestAnimationFrame(refresh.bind(this));
-}
+};
 
 Renderer.prototype.getZoom = function () {
     return this._zoom;