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

Configuration level for ScalaDocChecker #173

Open
ajtkulov opened this issue Nov 25, 2015 · 1 comment
Open

Configuration level for ScalaDocChecker #173

ajtkulov opened this issue Nov 25, 2015 · 1 comment
Labels

Comments

@ajtkulov
Copy link

It seems that false positive in ScalaDocChecker is solved #123 (at least, merged).

So, what about introduce ScalaDocChecker level?
Now developer have to comment almost everything. Classes, traits, methods, types, properties (val's inside classes). It's overwhelming (from my point of view - mostly useless).

For instance, I'd like to configure entities that I want to check by ScalaDoc. Like, only classes, case classes, objects, traits. Nothing else. Someone else wants check also methods and properties. Just configure it.

@matthewfarwell
Copy link
Member

You can to a certain extent, by ignoring certain classes according to a regular expression - see the ignoreRegex parameter. However, I agree that we shouldn't have to do everything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants