search

compodoc / compodoc

:notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
https://compodoc.app
MIT License
4k stars 401 forks source link

[FEATURE] exclude some files from being "scanned" for documentation coverage #1259

Closed Fitzchev closed 1 year ago

Fitzchev commented 2 years ago
Overview of the feature

I want to be able to exclude some files from being "scanned" for documentation coverage, but keep them in the documentation.

Motivation for or Use Case

I have some interfaces which are auto-generated by a script (dependency with another system) and so cannot be touched to add documentation (it could be regenerated anytime). They are all saved in a dedicated folder, and as is, they will always have 0% of documentation coverage. They are important to understand the app, so I want to keep them in the documentation anyway.

My question is: is there a way to exclude them from being "scanned" but keep them anyway in the generated doc?

Thanks in advance.

Related issues

None.

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 1 year ago

This issue has been automatically closed because it has not had recent activity. Please file a new issue if you are encountering a similar or related problem. Thank you for your contributions.