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

Ability to instruct scaladoc to exclude packages/classes #5533

Closed
scabug opened this Issue Mar 1, 2012 · 4 comments

Comments

Projects
None yet
2 participants
@scabug
Copy link

scabug commented Mar 1, 2012

I'd like to exclude certain packages and/or classes from Scaladoc's output, but I see nothing in its options that looks like it will satisfy.

For example, if my project consisted of:

foo.bar.Baz
foo.bar.Bif
foo.bar.BifImpl
foo.bar.impl.Bing
foo.bar.impl.Bang

I might like to exclude all of foo.bar.impl and foo.bar.BifImpl specifically.

I can control which source files are sent to Scaladoc, but that is insufficient for my purposes, both because AFAIK Scaladoc wants to actually compile things, in which case it needs all the source code. And in the project in question, the main author has chosen to put all source files in one top-level directory, instead of breaking them out by package. This makes excluding everything in the, for example, foo.bar.impl package more cumbersome.

@scabug

This comment has been minimized.

Copy link

scabug commented Mar 1, 2012

Imported From: https://issues.scala-lang.org/browse/SI-5533?orig=1
Reporter: @samskivert
Affected Versions: 2.10.0

@scabug

This comment has been minimized.

Copy link

scabug commented Jul 11, 2012

@VladUreche said:
Bumping to Critical, this will be need to document reflection.

@scabug

This comment has been minimized.

Copy link

scabug commented Jul 20, 2012

@scabug scabug closed this Jul 20, 2012

@scabug

This comment has been minimized.

Copy link

scabug commented Jul 23, 2012

@VladUreche said:
You can now use

scaladoc -skip-packages <pack1>:<pack2>:...:<packN> files.scala

or the ant skipPackages property to skip package expansion in scaladoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment