Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
xmo-odoo opened this issue Jun 27, 2017 · 0 comments

Comments

@xmo-odoo
Copy link

xmo-odoo commented Jun 27, 2017

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
anthony-redFox added a commit to anthony-redFox/documentation that referenced this issue Jul 5, 2017
Check on parent element: foo.bar sub-parametr should be documeted with parent.
Fixed documentationjs#832 issue
anthony-redFox added a commit to anthony-redFox/documentation that referenced this issue Jul 7, 2017
Check on parent element: foo.bar sub-parametr should be documeted with parent.
Fixed documentationjs#832 issue
@tmcw tmcw closed this as completed in #835 Jul 7, 2017
tmcw pushed a commit that referenced this issue Jul 7, 2017
Check on parent element: foo.bar sub-parametr should be documeted with parent.
Fixed #832 issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant