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

Jump to bottom

Scaladoc improperly includes package objects from library dependencies #10028

Open
scabug opened this issue Nov 4, 2016 · 2 comments
Open

Scaladoc improperly includes package objects from library dependencies #10028

scabug opened this issue Nov 4, 2016 · 2 comments
Labels
help wanted scaladoc tool
Milestone
Backlog

Comments

@scabug
Copy link

scabug commented Nov 4, 2016

Each is a library that depends on Scalaz. When I run sbt doc, it creates documentation alone with package objects from Scalaz. I expect it only contains the API from source code, not from libraries.

See https://travis-ci.org/ThoughtWorksInc/each/builds/173159356 for full log
@scabug
Copy link
Author

scabug commented Nov 4, 2016

Imported From: https://issues.scala-lang.org/browse/SI-10028?orig=1
Reporter: @Atry
Affected Versions: 2.10.6, 2.11.8, 2.12.0
Attachments:

@scabug
Copy link
Author

scabug commented Dec 26, 2016

Jonas Fonseca (fonseca) said (edited on Dec 26, 2016 7:25:53 PM UTC):
In the Scaladoc for Akka HTTP's {{akka-http}} sbt project, symbols from the upstream Akka dependency's {{akka.pattern}} package are listed. The symbols seem to all belong to traits which are mixed into the {{akka.pattern}}'s package object, for example [PipeableFuture and PipeableCompletionStage|https://github.com/akka/akka/blob/b1e146c8363f74a93c7a19df080551ba80a6022a/akka-actor/src/main/scala/akka/pattern/PipeToSupport.scala#L16]. As shown in [^akka.pattern package docs.png] only the package object HTML file is there so pages linked from the hierarchical menu to the right do not exists, e.g. .../akka/pattern/PipeableFuture.html

@scabug scabug added this to the Backlog milestone Apr 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted scaladoc tool
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
2 participants
@SethTisue @scabug