ESDoc updates

xeokit · Apr 22, 2021 · e2d5167 · e2d5167
1 parent 61eccfa
commit e2d5167
Show file tree

Hide file tree

Showing 401 changed files with 154,661 additions and 138,644 deletions.
diff --git a/.esdoc.json b/.esdoc.json
@@ -1,31 +1,51 @@
 {
-  "source": "./src/",
-  "destination": "./docs",
-  "excludes": [
-    "(workers|zipjs)"
-  ],
-  "plugins": [
-    {
-      "name": "esdoc-standard-plugin",
-      "includeSource": true,
-      "option": {
-        "lint": {"enable": true},
-        "coverage": {"enable": true},
-        "accessor": {"access": ["public"], "autoPrivate": true},
-        "undocumentIdentifier": {"enable": true},
-        "unexportedIdentifier": {"enable": false},
-        "typeInference": {"enable": true},
-
-        "brand": {
-          "logo": "./assets/images/logo.jpg",
-          "title": "xeokit-sdk",
-          "description": "3D engineering graphics in the browser",
-          "repository": "https://github.com/xeokit/xeokit-sdk",
-          "site": "http://xeokit.io",
-          "author": "http://xeolabs.com",
-          "image": "./images/logo.jpg"
+    "source": "./src/",
+    "destination": "./docs",
+    "excludes": [
+        "(workers|zipjs)"
+    ],
+    "plugins": [
+        {
+            "name": "esdoc-publish-html-plugin",
+            "option": {
+                "template": "assets/esdocTemplate"
+            }
+        },
+        {
+            "name": "esdoc-standard-plugin",
+            "includeSource": true,
+            "option": {
+                "lint": {
+                    "enable": true
+                },
+                "coverage": {
+                    "enable": true
+                },
+                "accessor": {
+                    "access": [
+                        "public"
+                    ],
+                    "autoPrivate": true
+                },
+                "undocumentIdentifier": {
+                    "enable": true
+                },
+                "unexportedIdentifier": {
+                    "enable": false
+                },
+                "typeInference": {
+                    "enable": true
+                },
+                "brand": {
+                    "logo": "./assets/images/logo.jpg",
+                    "title": "xeokit-sdk",
+                    "description": "3D engineering graphics in the browser",
+                    "repository": "https://github.com/xeokit/xeokit-sdk",
+                    "site": "http://xeokit.io",
+                    "author": "http://xeolabs.com",
+                    "image": "./images/logo.jpg"
+                }
+            }
         }
-      }
-    }
-  ]
+    ]
 }
diff --git a/assets/esdocTemplate/class.html b/assets/esdocTemplate/class.html
@@ -0,0 +1,66 @@
+<div class="header-notice">
+  <div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode"></code></pre></div>
+  <span data-ice="access"></span>
+  <span data-ice="kind"></span>
+  <span data-ice="variation">| variation </span>
+  <span data-ice="version">| version </span>
+  <span data-ice="since">| since </span>
+  <span data-ice="source">| </span>
+</div>
+
+<div class="self-detail detail">
+  <h1 data-ice="name"></h1>
+
+  <div data-ice="instanceDocs" class="instance-docs">
+    <span>You can directly use an instance of this class.</span>
+    <span data-ice="instanceDoc"></span>
+  </div>
+
+  <div class="expression-extends" data-ice="expressionExtends"><h4>Expression Extends:</h4><pre class="prettyprint"><code data-ice="expressionExtendsCode"></code></pre></div>
+  <div class="flat-list" data-ice="mixinExtends"><h4>Mixin Extends:</h4></div>
+  <div class="flat-list" data-ice="extendsChain"><h4>Extends:</h4></div>
+  <div class="flat-list" data-ice="directSubclass"><h4>Direct Subclass:</h4></div>
+  <div class="flat-list" data-ice="indirectSubclass"><h4>Indirect Subclass:</h4></div>
+  <div class="flat-list" data-ice="implements"><h4>Implements:</h4></div>
+  <div class="flat-list" data-ice="indirectImplements"><h4>Indirect Implements:</h4></div>
+  <div class="flat-list" data-ice="directImplemented"><h4>Direct Implemented:</h4></div>
+  <div class="flat-list" data-ice="indirectImplemented"><h4>Indirect Implemented:</h4></div>
+
+  <div class="deprecated" data-ice="deprecated"></div>
+  <div class="experimental" data-ice="experimental"></div>
+  <div class="description" data-ice="description"></div>
+  <div class="decorator" data-ice="decorator"><h4>Decorators:</h4></div>
+
+  <div data-ice="see"><h4>See:</h4></div>
+
+  <div data-ice="exampleDocs">
+    <h4>Example:</h4>
+    <div class="example-doc" data-ice="exampleDoc">
+      <div class="example-caption" data-ice="exampleCaption"></div>
+      <pre class="prettyprint source-code"><code data-ice="exampleCode"></code></pre>
+    </div>
+  </div>
+
+  <div data-ice="tests">
+    <h4>Test:</h4>
+    <ul>
+      <li data-ice="test"></li>
+    </ul>
+  </div>
+
+  <div data-ice="todo"><h4>TODO:</h4></div>
+</div>
+
+<div data-ice="staticMemberSummary"><h2>Static Member Summary</h2></div>
+<div data-ice="staticMethodSummary"><h2>Static Method Summary</h2></div>
+<div data-ice="constructorSummary"><h2>Constructor Summary</h2></div>
+<div data-ice="memberSummary"><h2>Member Summary</h2></div>
+<div data-ice="methodSummary"><h2>Method Summary</h2></div>
+
+<div class="inherited-summary" data-ice="inheritedSummary"><h2>Inherited Summary</h2></div>
+
+<div data-ice="staticMemberDetails"></div>
+<div data-ice="staticMethodDetails"></div>
+<div data-ice="constructorDetails"></div>
+<div data-ice="memberDetails"></div>
+<div data-ice="methodDetails"></div>
diff --git a/assets/esdocTemplate/css/github.css b/assets/esdocTemplate/css/github.css
@@ -0,0 +1,83 @@
+/* github markdown */
+.github-markdown {
+  font-size: 16px;
+}
+
+.github-markdown h1,
+.github-markdown h2,
+.github-markdown h3,
+.github-markdown h4,
+.github-markdown h5 {
+  margin-top: 1em;
+  margin-bottom: 16px;
+  font-weight: bold;
+  padding: 0;
+}
+
+.github-markdown h1:nth-of-type(1) {
+  margin-top: 0;
+}
+
+.github-markdown h1 {
+  font-size: 2em;
+  padding-bottom: 0.3em;
+}
+
+.github-markdown h2 {
+  font-size: 1.75em;
+  padding-bottom: 0.3em;
+}
+
+.github-markdown h3 {
+  font-size: 1.5em;
+}
+
+.github-markdown h4 {
+  font-size: 1.25em;
+}
+
+.github-markdown h5 {
+  font-size: 1em;
+}
+
+.github-markdown ul, .github-markdown ol {
+  padding-left: 2em;
+}
+
+.github-markdown pre > code {
+  font-size: 0.85em;
+}
+
+.github-markdown table {
+  margin-bottom: 1em;
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+
+.github-markdown table tr {
+  background-color: #fff;
+  border-top: 1px solid #ccc;
+}
+
+.github-markdown table th,
+.github-markdown table td {
+  padding: 6px 13px;
+  border: 1px solid #ddd;
+}
+
+.github-markdown table tr:nth-child(2n) {
+  background-color: #f8f8f8;
+}
+
+.github-markdown hr {
+  border-right: 0;
+  border-bottom: 1px solid #e5e5e5;
+  border-left: 0;
+  border-top: 0;
+}
+
+/** badge(.svg) does not have border */
+.github-markdown img:not([src*=".svg"]) {
+  max-width: 100%;
+  box-shadow: 1px 1px 1px rgba(0,0,0,0.5);
+}
diff --git a/assets/esdocTemplate/css/identifiers.css b/assets/esdocTemplate/css/identifiers.css
@@ -0,0 +1,37 @@
+.identifiers-wrap {
+  display: flex;
+  align-items: flex-start;
+}
+
+.identifier-dir-tree {
+  background: #fff;
+  border: solid 1px #ddd;
+  border-radius: 0.25em;
+  top: 52px;
+  position: -webkit-sticky;
+  position: sticky;
+  max-height: calc(100vh - 155px);
+  overflow-y: scroll;
+  min-width: 200px;
+  margin-left: 1em;
+}
+
+.identifier-dir-tree-header {
+  padding: 0.5em;
+  background-color: #fafafa;
+  border-bottom: solid 1px #ddd;
+}
+
+.identifier-dir-tree-content {
+  padding: 0 0.5em 0;
+}
+
+.identifier-dir-tree-content > div {
+  padding-top: 0.25em;
+  padding-bottom: 0.25em;
+}
+
+.identifier-dir-tree-content a {
+  color: inherit;
+}
+