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

'exlude by config' on files #17

Closed
Seanitzel opened this issue Apr 19, 2019 · 3 comments
Closed

'exlude by config' on files #17

Seanitzel opened this issue Apr 19, 2019 · 3 comments

Comments

@Seanitzel
Copy link

I've been using this great package without any problems for the last few weeks,
but today after adding some docs to some files and trying to generate the new docs with them included i get this strange msg on these files:

image

I went through any configuration i have in the whole project to try and find what might cause this to happen without any success.

Other folders which are excluded have this msg:

image

This is how that folder appears in the generated config:

image

Would appreciate help :)

@ph1p
Copy link
Owner

ph1p commented Apr 19, 2019

I'll take a look at it ;) can you please upload a zip or something else, so I can easier reproduce and fix it

@Seanitzel
Copy link
Author

Seanitzel commented Apr 19, 2019

bug.zip

Found the bug :)
Apparently it 'exludes' files when somewhere inside them some version of returning an array appears...

@returns {[]}

That includes combinations of that with other parameters or when they contain a type.

to reproduce just run:

yarn
yarn docs

output:

image

@Seanitzel Seanitzel changed the title 'exlude by config' on folder 'exlude by config' on files Apr 19, 2019
ph1p added a commit that referenced this issue Apr 23, 2019
@ph1p
Copy link
Owner

ph1p commented Apr 23, 2019

Thank you. Unfortunately this is a jsdoc error :/ I have added more meaningful errors.

You can do this:

@returns {Array}

@ph1p ph1p closed this as completed Apr 23, 2019
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

2 participants