my eyes! how can you even read that output :/

:) I suspect a non-string argument got passed to cleanName() function; which tries some replace operation on it.

Can you replace cleanName() function in your local node_modules/jsdoc-x/src/lib/utils.js with the code below to see the cause:

function cleanName(name) {
    try {
        return (name || '').replace(/([^>]+>)?~?(.*)/, '$2')
            .replace(/^(module\.)?exports\./, '');
    } catch (err) {
        console.log('----> name:', name);
        console.log('----> type:', typeof name);
        throw err; // re-throw
    }
}

I think this can be fixed with:

function cleanName(name) {
    return String(name || '').replace(/([^>]+>)?~?(.*)/, '$2')
        .replace(/^(module\.)?exports\./, '');
}

Thanks for the quick response, @onury!

New information logged:

----> name: 48
----> type: number

When using your suggested fix, I don't see error output in PowerShell, but when serving the output I get a blank screen and a console error:

At some point, helper.getSymbolInfo is called with a kind, scope, and asButton of undefined. The symbol passed into getSymbolData looks like this:

$docmaLink: "?api#module:@public.waitForEnabledElementImageToLoad"
$kind: "constant"
$longname: "module:@public.waitForEnabledElementImageToLoad"
comment: "/**↵ * A promise that returns an EnabledElement who's image has loaded, or↵ * null if the provided element ceases being an enabledElement before an↵ * image has been loaded.↵ *↵ * @param {HTMLElement} element - An element that is an EnabledElement↵ * @returns {EnabledElement}↵ */"
description: "A promise that returns an EnabledElement who's image has loaded, or↵null if the provided element ceases being an enabledElement before an↵image has been loaded."
kind: "constant"
longname: "module:@public.waitForEnabledElementImageToLoad"
memberof: "module:@public"
meta:
code: {id: "astnode100069452", name: "exports.waitForEnabledElementImageToLoad", type: "VariableDeclaration"}
columnno: 0
filename: "wait.js"
lineno: 21
path: "C:\code\CornerstonePlayground\src\cornerstoneTools\src\util"
range: (2) [626, 1067]
__proto__: Object
name: "waitForEnabledElementImageToLoad"
params: Array(1)
0:
description: "An element that is an EnabledElement"
name: "element"
type:
names: ["HTMLElement"]
...
returns: Array(1)
0:
type:
names: ["EnabledElement"]
...

Because it has a kind of constant, it is not handled by any of the if statements in getSymbolData and helper.getSymbolInfo is called with 0 arguments passed. helper.getSymbolInfo looks like it will always throw if kind is empty, so helper.getSymbolInfo should never be called without arguments?

If it helps, here is what the original code for that module looks like:

import external from './../externalModules.js';

/**
 * Waits a set amount of time, then resolves. Can be chained off of to delay
 * next call in promise chain.
 *
 * @exports @public @function
 * @param {number} ms - number in ms to wait
 * @returns {Promise}
 */
export const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

/**
 * A promise that returns an EnabledElement who's image has loaded, or
 * null if the provided element ceases being an enabledElement before an
 * image has been loaded.
 *
 * @param {HTMLElement} element - An element that is an EnabledElement
 * @returns {EnabledElement}
 */
export const waitForEnabledElementImageToLoad = (element) => {
  try {
    const enabledElement = external.cornerstone.getEnabledElement(element);

    if (!enabledElement.image) {
      return wait(250).then(() => waitForEnabledElementImageToLoad(element));
    }

    // EnabledElement's image is loaded.
    return enabledElement;
  } catch (ex) {
    // Is no longer, or never was an enabled element, stop polling
    return null;
  }
};

export default wait;

Looking closer at existing issues, I think we've identified one new issue, and stumbled upon a second. The second issue appears to be a duplicate of: #41

Update: I was able to get documentation generation and served by doing the following:

• Apply the fix mentioned in your latest comment in this thread
• Update all @returns to include a valid type (Uncaught TypeError: Cannot read property 'names' of undefined #55)

Everything appears to be working beautifully now 👍 I would be open to contributing changes that address these issues if you are willing to review a PR? Any guidance you have would be appreciated.

Thanks. I'm fixing this with some other revisions. I'll let you know.

This is fixed now.
I'm waiting for users on other issues before I release new version.

Fixed with Docma v3.0.0.

I am migrating an old template from v1 to v2 and stumbled upon this bug. Is there a workaround for this other than patching jsdoc-x?

Note: I am planning to move to the latest v3 version later but one step at a time :)