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
Scaladoc ignores package objects of otherwise empty packages #8124
Comments
Imported From: https://issues.scala-lang.org/browse/SI-8124?orig=1 |
@som-snytt said: |
Andrzej Giniewicz (giniu) said: |
Still broken in Scala 2.12's new Scaladoc. See for example the doc at https://www.scala-js.org/api/scalajs-library/1.0.0-M1/scala/scalajs/js/index.html, where the subpackage FTR, its source is here: https://github.com/scala-js/scala-js/blob/master/library/src/main/scala/scala/scalajs/js/special/package.scala |
After some debugging, it seems that scaladoc is ignoring package objects here when it shouldn't. However, (naively) removing the @VladUreche, can you point me out to where in the code should I be looking? Should I try to make a special case here for a package object with no "class/object" contents here? I don't know at all the scaladoc architecture, but I may be able to find a fix if you help me :) |
@ruippeixotog I don't remember my approach, but I intervened earlier, it seems. Since I submitted a PR, it must have been close but no cigar. |
Any plane to get this bug fixed? This situation is quite common when we create a DSL on top of Java library. Thanks |
Scaladoc does not appear to produce any documentation for doc-commented package objects whose packages contain no other top-level entities. For example, a package of top-level functions, all defined in the package object, is not shown at all in the Scaladoc output.
The text was updated successfully, but these errors were encountered: