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 does not add members of package objects to the method index #5558
Comments
Imported From: https://issues.scala-lang.org/browse/SI-5558?orig=1 |
@heathermiller said: Vlad, since this is in your realm of Scaladoc bugfixes, I'm tossing this one to you. |
@VladUreche said: So I'm bouncing this back to Documentation Team, hoping tomorrow it will rain patches ;) |
@heathermiller said (edited on Mar 8, 2012 6:45:52 PM UTC): So even if you ask for packages to be included in the filtered results, still no members of package objects show up. |
@heathermiller said: |
@VladUreche said: package object Hello {
object A
object B
} |
@heathermiller said (edited on Mar 8, 2012 7:00:51 PM UTC): See scala.collection.parallel.package. Note the method Then, navigate to the "S" index page: http://www.scala-http://www.scala-lang.org/archives/downloads/distrib/files/nightly/docs/library/index.html#index.index-s There's no |
@VladUreche said: |
Derek Wyatt (derekwyatt) said: NONE of these look up in the scaladoc. Thus... scala doesn't have this ability. Obviously that statement is incorrect, since math.pow() exists, but I can't find it unless I know that it's on the math package object already. But I didn't know that... |
@heathermiller said: |
@heathermiller said: Though something that might be of use to you in general is http://scalex.org/. You can easily search for methods as well as anything with a non-alphabetic name pretty easily. Your original inquiry is more helpful here: http://scalex.org/?q=pow It's something I'll integrate into the search bar on http://docs.scala-lang.org. |
@dcsobral said: |
@VladUreche said: |
@manojo said: Normally, the owner of a member is the template it is defined in, and this is computed with the makeTemplate function (by using the owner of the symbol of a member), where it will normally find a correspondence. In the case of a member of a package object, however, it seems that the owner of such a member does not correspond to the package, but to a generic symbol having the name "package" TL;DR the symbol table does not seem to map owners correctly for members of package objects, so the issue seems to be during symbol table generation. |
@dgruntz said: Dominik |
@magarciaEPFL said: |
@adriaanm said: |
@VladUreche said: |
If you want to find the 'pow' method, for example, and you don't know where it is, you might go to the method index (i.e. the a-z index underneath the search field in the left frame). You click on 'p' and then look for 'pow'. You won't find it - ScalaDoc doesn't put members of package objects into this index.
Also:
Another thing which I realized while browsing through the index is the way in which the index entries are written, i.e. are capitalized.
Example: STAR: is defined in Trees.Star, Base.Star and Tokens.STAR, but listed in the index as STAR only. Probably all defined capitalizations could be listed on the index-title-line instead of only one (arbitrarily) chosen one. (noticed by Dominik)
The text was updated successfully, but these errors were encountered: