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

How to disable doc for just a line #571

Open
datdinhquoc opened this issue May 20, 2021 · 0 comments
Open

How to disable doc for just a line #571

datdinhquoc opened this issue May 20, 2021 · 0 comments

Comments

@datdinhquoc
Copy link

datdinhquoc commented May 20, 2021

Short summary of your issue

I need to disable a line which is the same in every file, ESDoc put all of them into output doc unnecessarily.

Input data for reproducing

Codes

// I have this line in all files
const log = console.log;

Issue

With a hundred files, ESDoc generates the same 100 log entries in the output doc.
That log is useful in all files but it's pointless in documentation.

Solution?

Wish there could be something similar to this:

// @ignore
const log = console.log;

Another way is to set this:

"undocumentIdentifier": {"enable": false}

but the @ignore tag is still better.

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