npm - rclnodejs - Versions diffs - 1.8.3 → 1.9.0 - Mend

rclnodejs 1.8.3 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (90) hide show

package/README.md +46 -37
package/index.js +39 -0
package/lib/action/client.js +61 -3
package/lib/action/server_goal_handle.js +26 -1
package/lib/message_info.js +94 -0
package/lib/node.js +260 -13
package/lib/parameter_event_handler.js +566 -0
package/lib/parameter_watcher.js +12 -12
package/lib/qos_overriding_options.js +358 -0
package/lib/subscription.js +38 -5
package/lib/timer.js +3 -2
package/lib/wait_for_message.js +111 -0
package/package.json +7 -4
package/prebuilds/linux-arm64/humble-jammy-arm64-rclnodejs.node +0 -0
package/prebuilds/linux-arm64/jazzy-noble-arm64-rclnodejs.node +0 -0
package/prebuilds/linux-arm64/kilted-noble-arm64-rclnodejs.node +0 -0
package/prebuilds/linux-x64/humble-jammy-x64-rclnodejs.node +0 -0
package/prebuilds/linux-x64/jazzy-noble-x64-rclnodejs.node +0 -0
package/prebuilds/linux-x64/kilted-noble-x64-rclnodejs.node +0 -0
package/scripts/run_asan_test.sh +118 -0
package/src/executor.cpp +36 -2
package/src/executor.h +11 -0
package/src/rcl_action_client_bindings.cpp +70 -1
package/src/rcl_context_bindings.cpp +3 -3
package/src/rcl_graph_bindings.cpp +2 -2
package/src/rcl_subscription_bindings.cpp +70 -2
package/src/rcl_timer_bindings.cpp +21 -2
package/src/rcl_utilities.cpp +2 -2
package/tools/jsdoc/Makefile +5 -0
package/tools/jsdoc/README.md +96 -0
package/tools/jsdoc/build-index.js +610 -0
package/tools/jsdoc/publish.js +854 -0
package/tools/jsdoc/regenerate-published-docs.js +605 -0
package/tools/jsdoc/static/fonts/OpenSans-Bold-webfont.eot +0 -0
package/tools/jsdoc/static/fonts/OpenSans-Bold-webfont.svg +1830 -0
package/tools/jsdoc/static/fonts/OpenSans-Bold-webfont.woff +0 -0
package/tools/jsdoc/static/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/tools/jsdoc/static/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
package/tools/jsdoc/static/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/tools/jsdoc/static/fonts/OpenSans-Italic-webfont.eot +0 -0
package/tools/jsdoc/static/fonts/OpenSans-Italic-webfont.svg +1830 -0
package/tools/jsdoc/static/fonts/OpenSans-Italic-webfont.woff +0 -0
package/tools/jsdoc/static/fonts/OpenSans-Light-webfont.eot +0 -0
package/tools/jsdoc/static/fonts/OpenSans-Light-webfont.svg +1831 -0
package/tools/jsdoc/static/fonts/OpenSans-Light-webfont.woff +0 -0
package/tools/jsdoc/static/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/tools/jsdoc/static/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
package/tools/jsdoc/static/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/tools/jsdoc/static/fonts/OpenSans-Regular-webfont.eot +0 -0
package/tools/jsdoc/static/fonts/OpenSans-Regular-webfont.svg +1831 -0
package/tools/jsdoc/static/fonts/OpenSans-Regular-webfont.woff +0 -0
package/tools/jsdoc/static/scripts/linenumber.js +25 -0
package/tools/jsdoc/static/scripts/prettify/Apache-License-2.0.txt +202 -0
package/tools/jsdoc/static/scripts/prettify/lang-css.js +36 -0
package/tools/jsdoc/static/scripts/prettify/prettify.js +738 -0
package/tools/jsdoc/static/styles/jsdoc-default.css +1012 -0
package/tools/jsdoc/static/styles/prettify-jsdoc.css +111 -0
package/tools/jsdoc/static/styles/prettify-tomorrow.css +132 -0
package/tools/jsdoc/tmpl/augments.tmpl +10 -0
package/tools/jsdoc/tmpl/container.tmpl +193 -0
package/tools/jsdoc/tmpl/details.tmpl +143 -0
package/tools/jsdoc/tmpl/example.tmpl +2 -0
package/tools/jsdoc/tmpl/examples.tmpl +13 -0
package/tools/jsdoc/tmpl/exceptions.tmpl +17 -0
package/tools/jsdoc/tmpl/layout.tmpl +83 -0
package/tools/jsdoc/tmpl/mainpage.tmpl +163 -0
package/tools/jsdoc/tmpl/members.tmpl +43 -0
package/tools/jsdoc/tmpl/method.tmpl +124 -0
package/tools/jsdoc/tmpl/params.tmpl +133 -0
package/tools/jsdoc/tmpl/properties.tmpl +110 -0
package/tools/jsdoc/tmpl/returns.tmpl +12 -0
package/tools/jsdoc/tmpl/source.tmpl +8 -0
package/tools/jsdoc/tmpl/tutorial.tmpl +19 -0
package/tools/jsdoc/tmpl/type.tmpl +7 -0
package/types/action_client.d.ts +8 -0
package/types/index.d.ts +34 -0
package/types/message_info.d.ts +72 -0
package/types/node.d.ts +90 -5
package/types/parameter_event_handler.d.ts +150 -0
package/types/qos.d.ts +55 -0
package/types/subscription.d.ts +14 -2
package/types/timer.d.ts +3 -2
package/test_data_integrity.js +0 -108
package/test_repro_exact.js +0 -57
package/test_repro_hz.js +0 -86
package/test_repro_pub.js +0 -36
package/test_repro_stress.js +0 -83
package/test_repro_sub.js +0 -64
package/test_xproc_data.js +0 -64
package/types/interfaces.d.ts +0 -8895

package/tools/jsdoc/tmpl/layout.tmpl ADDED Viewed

@@ -0,0 +1,83 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>JSDoc: <?js= title ?></title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<?js
+    var packageInfo = this.packageInfo || {};
+    var packageName = packageInfo.name || 'rclnodejs';
+    var packageVersion = packageInfo.version || '';
+    var packageDescription = packageInfo.description || 'ROS 2 client library for Node.js and TypeScript';
+?>
+<body>
+<div class="site-backdrop"></div>
+<div class="site-grid"></div>
+<div class="app-shell">
+    <aside class="site-sidebar">
+        <div class="brand-card">
+            <a class="brand-link" href="index.html">
+                <span class="brand-kicker">ROS 2 JavaScript Client</span>
+                <strong class="brand-title"><?js= packageName ?></strong>
+                <?js if (packageVersion) { ?>
+                <span class="brand-version">v<?js= packageVersion ?></span>
+                <?js } ?>
+            </a>
+            <p class="brand-description"><?js= packageDescription ?></p>
+        </div>
+        <button class="nav-toggle" type="button" aria-expanded="false" aria-controls="site-nav">
+            Browse API
+        </button>
+        <nav class="site-nav" id="site-nav">
+            <?js= this.nav ?>
+        </nav>
+    </aside>
+    <div class="site-main">
+        <header class="site-header">
+            <p class="page-eyebrow"><?js= title === 'Home' ? 'Documentation' : 'API Reference' ?></p>
+            <h1 class="page-title"><?js= title ?></h1>
+            <p class="page-subtitle"><?js= packageDescription ?></p>
+        </header>
+        <main id="main">
+            <?js= content ?>
+        </main>
+        <footer class="site-footer">
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc <?js= env.version.number ?></a><?js if(env.conf.templates && env.conf.templates.default && env.conf.templates.default.includeDate !== false) { ?> on <?js= (new Date()) ?><?js } ?>
+        </footer>
+    </div>
+</div>
+<script>
+    prettyPrint();
+    (function() {
+        var button = document.querySelector('.nav-toggle');
+        var shell = document.querySelector('.app-shell');
+        if (!button || !shell) {
+            return;
+        }
+        button.addEventListener('click', function() {
+            var isOpen = shell.classList.toggle('nav-open');
+            button.setAttribute('aria-expanded', isOpen ? 'true' : 'false');
+        });
+    }());
+</script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

package/tools/jsdoc/tmpl/mainpage.tmpl ADDED Viewed

@@ -0,0 +1,163 @@
+<?js
+var data = obj;
+var self = this;
+var homepage = this.homepage || {};
+?>
+<?js if (data.kind === 'package') { ?>
+    <section class="hero-card">
+        <div class="hero-layout">
+            <div class="hero-copy">
+                <p class="hero-kicker">JavaScript and TypeScript ROS 2 API</p>
+                <h2><?js= data.name ?> <span><?js= data.version ?></span></h2>
+                <?js if (data.description) { ?>
+                <p class="hero-description"><?js= data.description ?></p>
+                <?js } ?>
+                <p class="hero-lead">Build ROS 2 nodes with a Node.js-native workflow, generated message bindings, and TypeScript-friendly APIs.</p>
+                <div class="hero-actions">
+                    <a class="hero-action primary" href="<?js= homepage.installUrl || '#installation' ?>">Get Started</a>
+                    <a class="hero-action" href="<?js= homepage.coreModuleUrl || 'module-rclnodejs.html' ?>">Browse Core API</a>
+                    <a class="hero-action" href="<?js= homepage.typescriptUrl || '#using-rclnodejs-with-typescript' ?>">TypeScript Guide</a>
+                </div>
+                <div class="hero-tags">
+                    <span>ROS 2</span>
+                    <span>Node.js</span>
+                    <span>TypeScript</span>
+                </div>
+            </div>
+            <div class="hero-panel">
+                <p class="hero-panel-title">Quick Start</p>
+                <pre class="prettyprint hero-snippet"><code>npm i rclnodejs</code></pre>
+                <ul class="hero-points">
+                    <li>Works with sourced ROS 2 environments</li>
+                    <li>Supports generated message and IDL workflows</li>
+                    <li>Covers topics, services, actions, lifecycle, and time</li>
+                </ul>
+            </div>
+        </div>
+    </section>
+    <section class="homepage-strip stats-strip">
+        <?js (homepage.stats || []).forEach(function(stat) { ?>
+        <article class="stats-card">
+            <strong><?js= stat.value ?></strong>
+            <span><?js= stat.label ?></span>
+            <p><?js= stat.detail ?></p>
+        </article>
+        <?js }); ?>
+    </section>
+<?js } ?>
+<?js if (data.kind === 'mainpage') { ?>
+    <section class="homepage-grid">
+        <article class="homepage-card homepage-card-wide">
+            <p class="section-kicker">Why rclnodejs</p>
+            <h3>Engineering ergonomics for robotics teams using JavaScript</h3>
+            <p>rclnodejs lets teams build ROS 2 software in Node.js without losing alignment with the broader ROS ecosystem. The API stays close to core ROS concepts while fitting JavaScript and TypeScript workflows.</p>
+        </article>
+        <article class="homepage-card">
+            <p class="section-kicker">Core API</p>
+            <h3><a href="<?js= homepage.coreModuleUrl || 'module-rclnodejs.html' ?>">Start with the runtime module</a></h3>
+            <p>Move from the package entry point into Node, Publisher, Subscription, Client, Service, and Action primitives.</p>
+        </article>
+        <article class="homepage-card">
+            <p class="section-kicker">Reference</p>
+            <h3><a href="<?js= homepage.globalUrl || 'global.html' ?>">Inspect globals and enums</a></h3>
+            <p>Policies, event types, clock kinds, return codes, and shared constants are collected in one place for fast lookup.</p>
+        </article>
+    </section>
+    <section class="homepage-guides">
+        <header class="doc-page-header compact-header">
+            <p class="section-kicker">Guides</p>
+            <h3>Get productive without leaving the entry page</h3>
+            <p>These short guides cover the main README workflows: setup, typed development, and interface generation.</p>
+        </header>
+        <div class="guide-grid">
+            <article class="guide-card" id="guide-installation">
+                <p class="section-kicker">Setup</p>
+                <h3>Installation and environment</h3>
+                <p>Install Node.js 16.13.0 or newer, install a compatible ROS 2 distribution, then source the ROS 2 setup file before using the package.</p>
+                <pre class="prettyprint"><code>source /opt/ros/&lt;distro&gt;/setup.bash
+npm i rclnodejs</code></pre>
+                <ul class="guide-list">
+                    <li>Use <code>npm i rclnodejs@x.y.z</code> when you need a specific package version.</li>
+                    <li>Generate a local reference site at any time with <code>npm run docs</code>.</li>
+                    <li>Start exploring the runtime surface in <a href="<?js= homepage.coreModuleUrl || 'module-rclnodejs.html' ?>">the core API module</a>.</li>
+                </ul>
+            </article>
+            <article class="guide-card" id="guide-typescript">
+                <p class="section-kicker">TypeScript</p>
+                <h3>Typed project setup</h3>
+                <p>rclnodejs ships declaration files in the <code>types/</code> folder so projects get editor assistance, generated message types, and compile-time checks.</p>
+                <pre class="prettyprint"><code>{
+  "compilerOptions": {
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "target": "es6"
+  }
+}</code></pre>
+                <ul class="guide-list">
+                    <li>Use the generated declarations for message interfaces after running the message generator.</li>
+                    <li>Follow the <a href="<?js= homepage.typescriptUrl || '#guide-typescript' ?>">TypeScript workflow</a> here before moving into application code.</li>
+                    <li>Pair typed code with the class docs for Node, Publisher, Subscription, Service, and Action primitives.</li>
+                </ul>
+            </article>
+            <article class="guide-card" id="guide-message-generation">
+                <p class="section-kicker">Interfaces</p>
+                <h3>Message and IDL generation</h3>
+                <p>When your ROS installation changes or your project depends on additional message packages, regenerate the JavaScript and TypeScript bindings from the current environment.</p>
+                <pre class="prettyprint"><code>npx generate-ros-messages
+npm run generate-messages-idl</code></pre>
+                <ul class="guide-list">
+                    <li>Use <code>npx generate-ros-messages</code> for standard ROS interfaces available in the sourced environment.</li>
+                    <li>Use <code>npm run generate-messages-idl</code> when you need IDL-driven generation.</li>
+                    <li>Generated JavaScript files are written under your installed package's <code>generated/</code> directory.</li>
+                </ul>
+            </article>
+        </div>
+        <div class="guide-grid guide-grid-secondary">
+            <article class="guide-card">
+                <p class="section-kicker">First Node</p>
+                <h3>Publish a message in a few lines</h3>
+                <p>The package stays close to ROS 2 concepts while keeping the Node.js workflow straightforward.</p>
+                <pre class="prettyprint"><code>const rclnodejs = require('rclnodejs');
+rclnodejs.init().then(() =&gt; {
+  const node = new rclnodejs.Node('publisher_example_node');
+  const publisher = node.createPublisher('std_msgs/msg/String', 'topic');
+  publisher.publish('Hello ROS 2 from rclnodejs');
+  node.spin();
+});</code></pre>
+            </article>
+            <article class="guide-card">
+                <p class="section-kicker">Further Reading</p>
+                <h3>Keep moving from overview to implementation</h3>
+                <ul class="guide-list guide-list-tight">
+                    <li><a href="<?js= homepage.coreModuleUrl || 'module-rclnodejs.html' ?>">Core module reference</a></li>
+                    <li><a href="<?js= homepage.globalUrl || 'global.html' ?>">Globals and enums</a></li>
+                    <li><a href="module-validator.html">Validation helpers</a></li>
+                    <li><a href="https://github.com/RobotWebTools/rclnodejs/tree/develop/example">Examples in the repository</a></li>
+                </ul>
+            </article>
+        </div>
+    </section>
+<?js if (data.readme) { ?>
+    <section class="doc-section prose-section readme-section">
+        <header class="doc-page-header compact-header">
+            <p class="section-kicker">Manual</p>
+            <h3>Full project guide</h3>
+            <p>The complete README remains below for installation details, CLI workflows, TypeScript usage, and message-generation procedures.</p>
+        </header>
+        <article class="prose-card"><?js= data.readme ?></article>
+    </section>
+<?js } ?>
+<?js } ?>

package/tools/jsdoc/tmpl/members.tmpl ADDED Viewed

@@ -0,0 +1,43 @@
+<?js
+var data = obj;
+var self = this;
+?>
+<section class="symbol-card symbol-kind-<?js= kind ?>">
+<div class="symbol-heading">
+    <span class="symbol-kind"><?js= kind ?></span>
+    <h4 class="name" id="<?js= id ?>"><?js= data.attribs + name + (data.signature ? data.signature : '') ?></h4>
+</div>
+<?js if (data.summary) { ?>
+<p class="summary"><?js= summary ?></p>
+<?js } ?>
+<?js if (data.description) { ?>
+<div class="description">
+    <?js= data.description ?>
+</div>
+<?js } ?>
+<?js if (data.type && data.type.names) {?>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            <?js= self.partial('type.tmpl', data.type.names) ?>
+        </li>
+    </ul>
+<?js } ?>
+<?js= this.partial('details.tmpl', data) ?>
+<?js if (data.fires && fires.length) { ?>
+    <h5>Fires:</h5>
+    <ul><?js fires.forEach(function(f) { ?>
+        <li><?js= self.linkto(f) ?></li>
+    <?js }); ?></ul>
+<?js } ?>
+<?js if (data.examples && examples.length) { ?>
+    <h5>Example<?js= examples.length > 1? 's':'' ?></h5>
+    <?js= this.partial('examples.tmpl', examples) ?>
+<?js } ?>
+</section>

package/tools/jsdoc/tmpl/method.tmpl ADDED Viewed

@@ -0,0 +1,124 @@
+<?js
+var data = obj;
+var self = this;
+?>
+<section class="symbol-card symbol-kind-<?js= kind ?>">
+<?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
+    <?js if (data.kind === 'class' && data.classdesc) { ?>
+    <p class="section-kicker">Constructor</p>
+    <?js } ?>
+    <?js if (data.kind !== 'namespace') { ?>
+    <div class="symbol-heading">
+        <span class="symbol-kind"><?js= kind ?></span>
+        <h4 class="name" id="<?js= id ?>"><?js= data.attribs + (kind === 'class' ? 'new ' : '') +
+    name + (data.signature || '') ?></h4>
+    </div>
+    <?js } ?>
+    <?js if (data.summary) { ?>
+    <p class="summary"><?js= summary ?></p>
+    <?js } ?>
+<?js } ?>
+<?js if (data.kind !== 'module' && data.description && !data.hideconstructor) { ?>
+<div class="description">
+    <?js= data.description ?>
+</div>
+<?js } ?>
+<?js if (data.augments && data.alias && data.alias.indexOf('module:') === 0) { ?>
+    <h5>Extends:</h5>
+    <?js= self.partial('augments.tmpl', data) ?>
+<?js } ?>
+<?js if (kind === 'event' && data.type && data.type.names) {?>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            <?js= self.partial('type.tmpl', data.type.names) ?>
+        </li>
+    </ul>
+<?js } ?>
+<?js if (data['this']) { ?>
+    <h5>This:</h5>
+    <ul><li><?js= this.linkto(data['this'], data['this']) ?></li></ul>
+<?js } ?>
+<?js if (data.params && params.length && !data.hideconstructor) { ?>
+    <h5>Parameters:</h5>
+    <?js= this.partial('params.tmpl', params) ?>
+<?js } ?>
+<?js= this.partial('details.tmpl', data) ?>
+<?js if (data.kind !== 'module' && data.requires && data.requires.length) { ?>
+<h5>Requires:</h5>
+<ul><?js data.requires.forEach(function(r) { ?>
+    <li><?js= self.linkto(r) ?></li>
+<?js }); ?></ul>
+<?js } ?>
+<?js if (data.fires && fires.length) { ?>
+<h5>Fires:</h5>
+<ul><?js fires.forEach(function(f) { ?>
+    <li><?js= self.linkto(f) ?></li>
+<?js }); ?></ul>
+<?js } ?>
+<?js if (data.listens && listens.length) { ?>
+<h5>Listens to Events:</h5>
+<ul><?js listens.forEach(function(f) { ?>
+    <li><?js= self.linkto(f) ?></li>
+<?js }); ?></ul>
+<?js } ?>
+<?js if (data.listeners && listeners.length) { ?>
+<h5>Listeners of This Event:</h5>
+<ul><?js listeners.forEach(function(f) { ?>
+    <li><?js= self.linkto(f) ?></li>
+<?js }); ?></ul>
+<?js } ?>
+<?js if (data.exceptions && exceptions.length) { ?>
+<h5>Throws:</h5>
+<?js if (exceptions.length > 1) { ?><ul><?js
+    exceptions.forEach(function(r) { ?>
+        <li><?js= self.partial('exceptions.tmpl', r) ?></li>
+    <?js });
+?></ul><?js } else {
+    exceptions.forEach(function(r) { ?>
+        <?js= self.partial('exceptions.tmpl', r) ?>
+    <?js });
+} } ?>
+<?js if (data.returns && returns.length) { ?>
+<h5>Returns:</h5>
+<?js if (returns.length > 1) { ?><ul><?js
+    returns.forEach(function(r) { ?>
+        <li><?js= self.partial('returns.tmpl', r) ?></li>
+    <?js });
+?></ul><?js } else {
+    returns.forEach(function(r) { ?>
+        <?js= self.partial('returns.tmpl', r) ?>
+    <?js });
+} } ?>
+<?js if (data.yields && yields.length) { ?>
+<h5>Yields:</h5>
+<?js if (yields.length > 1) { ?><ul><?js
+    yields.forEach(function(r) { ?>
+        <li><?js= self.partial('returns.tmpl', r) ?></li>
+    <?js });
+?></ul><?js } else {
+    yields.forEach(function(r) { ?>
+        <?js= self.partial('returns.tmpl', r) ?>
+    <?js });
+} } ?>
+<?js if (data.examples && examples.length) { ?>
+    <h5>Example<?js= examples.length > 1? 's':'' ?></h5>
+    <?js= this.partial('examples.tmpl', examples) ?>
+<?js } ?>
+</section>

package/tools/jsdoc/tmpl/params.tmpl ADDED Viewed

@@ -0,0 +1,133 @@
+<?js
+    var params = obj;
+    /* sort subparams under their parent params (like opts.classname) */
+    var parentParam = null;
+    params.forEach(function(param, i) {
+        var paramRegExp;
+        if (!param) {
+            return;
+        }
+        if (parentParam && parentParam.name && param.name) {
+            try {
+                paramRegExp = new RegExp('^(?:' + parentParam.name + '(?:\\[\\])*)\\.(.+)$');
+            }
+            catch (e) {
+                // there's probably a typo in the JSDoc comment that resulted in a weird
+                // parameter name
+                return;
+            }
+            if ( paramRegExp.test(param.name) ) {
+                param.name = RegExp.$1;
+                parentParam.subparams = parentParam.subparams || [];
+                parentParam.subparams.push(param);
+                params[i] = null;
+            }
+            else {
+                parentParam = param;
+            }
+        }
+        else {
+            parentParam = param;
+        }
+    });
+    /* determine if we need extra columns, "attributes" and "default" */
+    params.hasAttributes = false;
+    params.hasDefault = false;
+    params.hasName = false;
+    params.forEach(function(param) {
+        if (!param) { return; }
+        if (param.optional || param.nullable || param.variable) {
+            params.hasAttributes = true;
+        }
+        if (param.name) {
+            params.hasName = true;
+        }
+        if (typeof param.defaultvalue !== 'undefined') {
+            params.hasDefault = true;
+        }
+    });
+?>
+<div class="table-wrap">
+<table class="params">
+    <thead>
+    <tr>
+        <?js if (params.hasName) {?>
+        <th>Name</th>
+        <?js } ?>
+        <th>Type</th>
+        <?js if (params.hasAttributes) {?>
+        <th>Attributes</th>
+        <?js } ?>
+        <?js if (params.hasDefault) {?>
+        <th>Default</th>
+        <?js } ?>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    <?js
+        var self = this;
+        params.forEach(function(param) {
+            if (!param) { return; }
+    ?>
+        <tr>
+            <?js if (params.hasName) {?>
+                <td class="name"><code><?js= param.name ?></code></td>
+            <?js } ?>
+            <td class="type">
+            <?js if (param.type && param.type.names) {?>
+                <?js= self.partial('type.tmpl', param.type.names) ?>
+            <?js } ?>
+            </td>
+            <?js if (params.hasAttributes) {?>
+                <td class="attributes">
+                <?js if (param.optional) { ?>
+                    &lt;optional><br>
+                <?js } ?>
+                <?js if (param.nullable) { ?>
+                    &lt;nullable><br>
+                <?js } ?>
+                <?js if (param.variable) { ?>
+                    &lt;repeatable><br>
+                <?js } ?>
+                </td>
+            <?js } ?>
+            <?js if (params.hasDefault) {?>
+                <td class="default">
+                <?js if (typeof param.defaultvalue !== 'undefined') { ?>
+                    <?js= self.htmlsafe(param.defaultvalue) ?>
+                <?js } ?>
+                </td>
+            <?js } ?>
+            <td class="description last"><?js= param.description ?><?js if (param.subparams) { ?>
+                <h6>Properties</h6>
+                <?js= self.partial('params.tmpl', param.subparams) ?>
+            <?js } ?></td>
+        </tr>
+    <?js }); ?>
+    </tbody>
+</table>
+</div>

package/tools/jsdoc/tmpl/properties.tmpl ADDED Viewed

@@ -0,0 +1,110 @@
+<?js
+    var data = obj;
+    var props = data.subprops || data.properties;
+    /* sort subprops under their parent props (like opts.classname) */
+    var parentProp = null;
+    props.forEach(function(prop, i) {
+        if (!prop) { return; }
+        if ( parentProp && prop.name && prop.name.indexOf(parentProp.name + '.') === 0 ) {
+            prop.name = prop.name.substr(parentProp.name.length+1);
+            parentProp.subprops = parentProp.subprops || [];
+            parentProp.subprops.push(prop);
+            props[i] = null;
+        }
+        else {
+            parentProp = prop;
+        }
+    });
+    /* determine if we need extra columns, "attributes" and "default" */
+    props.hasAttributes = false;
+    props.hasDefault = false;
+    props.hasName = false;
+    props.forEach(function(prop) {
+        if (!prop) { return; }
+        if (prop.optional || prop.nullable) {
+            props.hasAttributes = true;
+        }
+        if (prop.name) {
+            props.hasName = true;
+        }
+        if (typeof prop.defaultvalue !== 'undefined' && !data.isEnum) {
+            props.hasDefault = true;
+        }
+    });
+?>
+<div class="table-wrap">
+<table class="props">
+    <thead>
+    <tr>
+        <?js if (props.hasName) {?>
+        <th>Name</th>
+        <?js } ?>
+        <th>Type</th>
+        <?js if (props.hasAttributes) {?>
+        <th>Attributes</th>
+        <?js } ?>
+        <?js if (props.hasDefault) {?>
+        <th>Default</th>
+        <?js } ?>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    <?js
+        var self = this;
+        props.forEach(function(prop) {
+            if (!prop) { return; }
+    ?>
+        <tr>
+            <?js if (props.hasName) {?>
+                <td class="name"><code><?js= prop.name ?></code></td>
+            <?js } ?>
+            <td class="type">
+            <?js if (prop.type && prop.type.names) {?>
+                <?js= self.partial('type.tmpl', prop.type.names) ?>
+            <?js } ?>
+            </td>
+            <?js if (props.hasAttributes) {?>
+                <td class="attributes">
+                <?js if (prop.optional) { ?>
+                    &lt;optional><br>
+                <?js } ?>
+                <?js if (prop.nullable) { ?>
+                    &lt;nullable><br>
+                <?js } ?>
+                </td>
+            <?js } ?>
+            <?js if (props.hasDefault) {?>
+                <td class="default">
+                <?js if (typeof prop.defaultvalue !== 'undefined') { ?>
+                    <?js= self.htmlsafe(prop.defaultvalue) ?>
+                <?js } ?>
+                </td>
+            <?js } ?>
+            <td class="description last"><?js= prop.description ?><?js if (prop.subprops) { ?>
+                <h6>Properties</h6><?js= self.partial('properties.tmpl', prop) ?>
+            <?js } ?></td>
+        </tr>
+    <?js }); ?>
+    </tbody>
+</table>
+</div>

package/tools/jsdoc/tmpl/returns.tmpl ADDED Viewed

@@ -0,0 +1,12 @@
+<?js
+var data = obj || {};
+if (data.description) {
+?>
+<div class="param-desc">
+    <?js= description ?>
+</div>
+<?js } ?>
+<?js if (data.type && data.type.names) {?>
+<div class="returns-type"><span>Type</span> <?js= this.partial('type.tmpl', data.type.names) ?></div>
+<?js } ?>

package/tools/jsdoc/tmpl/source.tmpl ADDED Viewed

@@ -0,0 +1,8 @@
+<?js
+    var data = obj;
+?>
+    <section class="doc-section source-section">
+        <article class="prose-card">
+            <pre class="prettyprint source linenums"><code><?js= data.code ?></code></pre>
+        </article>
+    </section>