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

Enhancement for excludeNotDocumented option #2162

Closed
andrey-kuznetsov-osome opened this issue Feb 6, 2023 · 1 comment
Closed

Enhancement for excludeNotDocumented option #2162

andrey-kuznetsov-osome opened this issue Feb 6, 2023 · 1 comment
Labels
enhancement Improved functionality

Comments

@andrey-kuznetsov-osome
Copy link

Search Terms

excludeNotDocumented, option

Problem

I have a codebase with large set of non documented functions, classes, e.t.c

  1. If excludeNotDocumented = true I can see only documented classes, functions. But even if a whole class has documentation his properties, methods without docs are hidden.
  2. excludeNotDocumented = false I can see all non-documented properties, methods from documented classes but at the same time I see a rest of non-documented functions, classes which I don't want to include.

Suggested Solution

A mode when class, enum, interface, ... shows all it non documented members if it was documented on top level

@andrey-kuznetsov-osome andrey-kuznetsov-osome added the enhancement Improved functionality label Feb 6, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 10, 2023

Hmm, this ideally should be configurable at a more granular level, where you can specify what kinds of reflections should be removed by excludeNotDocumented... excludeNotDocumentedKinds isn't a horrible name, having difficulty coming up with something better.

Gerrit0 added a commit that referenced this issue Feb 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

2 participants