Skip to content

documentation lint does not warn against the "parent of <X> not found" build error #832

@xmo-odoo

Description

@xmo-odoo

When documenting sub-parameters without their parent (which sadly documentation does not infer), documentation lint does not show any warning but documentation build hard crashes. This is painful for old codebases with informal use of jsdoc tags as there can be many such instances.

Repro:

// test.js
/**
 * @param {Object} foo.bar
 */
function thing(foo) {}
> documentation lint test.js
> documentation build test.js
Error: Parent of foo.bar not found
(snip)
  • What version of documentation.js are you using?:
    4.0.0-rc.1
  • How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):
    cli

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions