Initial commit

config/jsdoc/index.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>CARTO.js</title>
+  <link type="text/css" rel="stylesheet" href="docs/v4/styles/jsdoc-default.css">
+</head>
+<body>
+  <h1 class="page-title">CARTO.js <span style="color:#0095dd;">v4</span></h1>
+  <ul style="margin:24px;">
+    <li><h3><a href="docs/v4">API docs</a></h3></li>
+    <li><h3><a href="docs/v4-internal">Internal docs</a><h3></li>
+    <li><h3><a href="examples/v4">Examples</a></h3></li>
+    <li><h3><a href="https://github.com/CartoDB/carto.js/tree/v4">GitHub repository</a><h3></li>
+  </ul>
+  <h4 style="margin-left:30px">Version:<span class="name"> %VERSION</span></h4>
+</body>
+</html>

config/jsdoc/internal-conf.json

@@ -0,0 +1,20 @@
+{
+  "source": {
+    "include": [
+      "src"
+    ]
+  },
+  "templates": {
+    "default": {
+      "outputSourceFiles": false,
+      "useLongnameInNav": true
+    }
+  },
+  "plugins": [
+    "plugins/markdown"
+  ],
+  "opts": {
+    "recurse": true,
+    "destination": "./docs/internal"
+  }
+}

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;
+    }
+  }
+};

config/jsdoc/public-conf.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"
+  }
+}