Nested Properties throw lodash errors.

[LazerFX]

Attempting to @typedef or @namespace nested properties (i.e. prop.val) will throw an error with lodash. Attempted with the JSDoc Tags Property demonstration code:

/**
 * @namespace
 * @property {object}  defaults               - The default values for parties.
 * @property {number}  defaults.players       - The default number of players.
 * @property {string}  defaults.level         - The default level for the party.
 * @property {object}  defaults.treasure      - The default treasure.
 * @property {number}  defaults.treasure.gold - How much gold the party starts with.
 */
var config = {
    defaults: {
        players: 1,
        level:   'beginner',
        treasure: {
            gold: 0
        }
    }
};

This throws the error:

lodash.templateSources[1]:136
__e( name) +
     ^

ReferenceError: name is not defined
    at eval (lodash.templateSources[1]:136:6)
    at Array.forEach (native)
    at eval (lodash.templateSources[1]:134:22)
    at Array.forEach (native)
    at eval (lodash.templateSources[1]:113:21)
    at eval (lodash.templateSources[3]:84:11)
    at Array.forEach (native)
    at eval (lodash.templateSources[3]:80:7)
    at C:\Users\PStreet\AppData\Roaming\npm\node_modules\documentation\default_theme\index.js:86:30
    at ConcatStream.<anonymous> (C:\Users\PStreet\AppData\Roaming\npm\node_modules\documentation\node_modules\concat-stream\index.js:36:43)

I've not had chance to go into the code to find out why it's failing, but I suspect there's a requirement for nesting in there that's not being met. Hope this is enough to reproduce/recreate the issue!

Running on:

• Windows 10 Pro (1607 - 14393.222 'Anniversary Update')
• NPM 3.10.8
• Node 6.7.0
• [email protected] (git://github.com/documentationjs/documentation.git#473a7a2dcecc67dc4addf68384561877eb871a3f)
• [email protected]

[chadxz]

@LazerFX were you using the html output with the default theme?

[LazerFX]

@chadxz Yes, I was...

--Edit--

If it helps, I've just downloaded the very latest build (npm install -g git+https://github.com/documentationjs/documentation.git#0fa38736cdc81172dde237f39f2e8d6168be9561e9561), and it's still happening, on both Windows 10 standard and Ubuntu Canonical 16.04 (Windows Subsystem for Linux).

[chadxz]

#576 fixes the error you described. However, the example you posted has two levels of nesting (defaults.treasure.gold) which the default html template does not support rendering. To get the treasure property to correctly show in docs generated using the default html template, you'd have to break that out into a separate typedef. Alternatively, you could alter the template to add support for rendering properties that deep.

[LazerFX]

To be honest, I'm surprised the default template doesn't handle the default examples on the @jsdoc page... As it is, this and the lack of folder support for Windows (#335) have actually made my decision for documentation provider fo rme; I'm using jsdoc with the jaguarjs-jsdoc template, and so far it's going well.

If you do fix the templating issue, I may look back in... Unfortunately, while I could give some time to decide on templates, documentation providers, etc. I've gotten to the point where I need to show progress in the workload assigned, rather than looking at the providers available. I may be able to look at the templates some in my spare time, but I'm not holding out much home. Sorry! I'd like to have been able to put a pull request in for this...

[chadxz]

@LazerFX that's understandable. best of luck!