bvalosek/jsdoc3-bootstrap

JSdoc3 template using bootstrap

jsdoc3-bootstrap's Issues

Event Hash link not correct

The following code does not link to the event properly.

/** @class Hurl */
function Hurl() {}

/**
 * Throw a snowball.
 *
 * @fires Hurl#snowball
 */
Hurl.prototype.snowball = function() {
    /**
     * Snowball event.
     *
     * @event Hurl#snowball
     * @type {object}
     * @property {boolean} isPacked - Indicates whether the snowball is tightly packed.
     */
    this.emit('snowball', {
        isPacked: this._snowball.isPacked
    });
};

module.exports = Hurl;

The generated page (Hurl.html) produces a Method snowball and an Event snowball. The link under the Method AND the Event generates as #snowball.

The Method should generate #snowball (and it does, properly). The Event should generate #event:snowball, which it currently does not.

edit: added full code

Cannot read properties of undefined (reading 'moduleName')

Hey, I'm trying to create a project with some sample JSDoc templates, and I'm having a problem compiling this one:

I just run: npm run jsdoc3Bootstrap:

> [email protected] jsdoc3Bootstrap
> jsdoc -c ./JSDocConfigs/jsdoc3Bootstrap.json

Parsing /workspace/jsdoc-templates-examples/src/2DObjects/Circle.js ...
Parsing /workspace/jsdoc-templates-examples/src/2DObjects/Object.js ...
Parsing /workspace/jsdoc-templates-examples/src/2DObjects/Objects.js ...
Parsing /workspace/jsdoc-templates-examples/src/2DObjects/Rectangle.js ...
Parsing /workspace/jsdoc-templates-examples/src/Fibonacci.js ...
Parsing /workspace/jsdoc-templates-examples/src/Maths/factorial.js ...
Parsing /workspace/jsdoc-templates-examples/src/Maths/index.js ...
Parsing /workspace/jsdoc-templates-examples/src/Maths/isEvenOdd.js ...
Parsing /workspace/jsdoc-templates-examples/src/Maths/sum.js ...
Parsing /workspace/jsdoc-templates-examples/src/capitalizeCase.js ...
Parsing /workspace/jsdoc-templates-examples/src/decimal2Binary.js ...
Parsing /workspace/jsdoc-templates-examples/src/index.js ...
Parsing /workspace/jsdoc-templates-examples/src/snakeCase.js ...
Generating output files...
undefined:35
((__t=( doc.meta.moduleName ))==null?'':__t)+
                 ^

TypeError: Cannot read properties of undefined (reading 'moduleName')
    at eval (eval at template (/workspace/jsdoc-templates-examples/node_modules/underscore/underscore-node-f.cjs:924:14), <anonymous>:35:18)
    at Array.forEach (<anonymous>)
    at Template.eval (eval at template (/workspace/jsdoc-templates-examples/node_modules/underscore/underscore-node-f.cjs:924:14), <anonymous>:8:10)
    at Template.template (/workspace/jsdoc-templates-examples/node_modules/underscore/underscore-node-f.cjs:931:19)
    at Template.partial (/workspace/jsdoc-templates-examples/node_modules/jsdoc/lib/jsdoc/template.js:55:33)
    at Template.render (/workspace/jsdoc-templates-examples/node_modules/jsdoc/lib/jsdoc/template.js:69:28)
    at generate (/workspace/jsdoc-templates-examples/node_modules/jsdoc3-bootstrap/publish.js:148:21)
    at Object.exports.publish (/workspace/jsdoc-templates-examples/node_modules/jsdoc3-bootstrap/publish.js:463:35)
    at Object.module.exports.cli.generateDocs (/workspace/jsdoc-templates-examples/node_modules/jsdoc/cli.js:441:39)
    at Object.module.exports.cli.processParseResults (/workspace/jsdoc-templates-examples/node_modules/jsdoc/cli.js:392:24)
    at module.exports.cli.main (/workspace/jsdoc-templates-examples/node_modules/jsdoc/cli.js:235:18)
    at Object.module.exports.cli.runCommand (/workspace/jsdoc-templates-examples/node_modules/jsdoc/cli.js:186:9)
    at /workspace/jsdoc-templates-examples/node_modules/jsdoc/jsdoc.js:93:9
    at Object.<anonymous> (/workspace/jsdoc-templates-examples/node_modules/jsdoc/jsdoc.js:94:3)
    at Module._compile (node:internal/modules/cjs/loader:1126:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1180:10)

Here is my project: https://github.com/201flaviosilva-labs/jsdoc-templates-examples/tree/jsdoc3-theme

:)

Erreur when using jsdoc3-bootstrap

When executing jsdoc, i having this issue :

Via jsdoc opts :

js: "C:/Users/ludovicdus/Desktop/Test JsDoc3/jsdoc-3.2.0/jsdoc.js", line 306: exception from uncaught JavaScript throw: Error: Unable to load template: Module "dotenv" not found.

Via : jsdoc.cmd -t jsdoc -t ./node_modules/jsdoc3-bootstrap

line 306: exception from uncaught JavaScript throw: Error: Unable to load template: Can't resolve relative module ID "./node_modules/jsdoc3-bootstrap/publish" when require() is used outside of a module

Add additional members to sidebar navigation

I've noticed that you're only adding in the classes in the sidebar navigation here. Any particular reason for this? This is by far my favorite jsdoc theme for being simple, mobile, and not as buggy as some of the others, but in my code, I have things other than classes that I'd like to show up in the navigation. It doesn't seem like it would be hard to implement, but I would be happy to submit a pull request if you'd like.