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

Provide a task option to suppress an entire package #128

Closed
codeprogression opened this issue Dec 14, 2016 · 3 comments
Closed

Provide a task option to suppress an entire package #128

codeprogression opened this issue Dec 14, 2016 · 3 comments
Assignees
Labels
enhancement An issue for a feature or an overall improvement
Milestone

Comments

@codeprogression
Copy link

I have a package that I would like to prevent from generating into the javadocs/kdocs.

I added @suppress to all of the class files within the packages but the package still shows up in the javadoc/kdoc index and generates a package page with no methods.

It would be great to have a directive in the dokka tasks for excluding the package.

dokka {
  ...
  suppressPackages = ['com.example.internal.*', 'com.example.secret']
  ...
}

Something like that would allow me to generate external vs internal documentation.

Thanks!

@mikehowson
Copy link

Yes please!

@semoro semoro self-assigned this Nov 23, 2017
@semoro semoro added the enhancement An issue for a feature or an overall improvement label Nov 23, 2017
@semoro semoro added this to the 0.9.16 milestone Nov 23, 2017
@semoro
Copy link
Contributor

semoro commented Nov 23, 2017

Fixed in GH-222

@semoro
Copy link
Contributor

semoro commented Feb 22, 2018

Fixed in 0.9.16

@semoro semoro closed this as completed Feb 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement
Projects
None yet
Development

No branches or pull requests

3 participants