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

Links in ScalaDoc - Spec and implementation unsufficient #4497

Closed
scabug opened this issue Apr 19, 2011 · 4 comments
Closed

Links in ScalaDoc - Spec and implementation unsufficient #4497

scabug opened this issue Apr 19, 2011 · 4 comments
Assignees
Milestone

Comments

@scabug
Copy link

@scabug scabug commented Apr 19, 2011

=== What steps will reproduce the problem? ===
Try linking to anything other than a class with ScalaDoc.

=== What is the expected behavior? ===
Links should be able to point to classes, objects(!), methods.
Choosing the right method in case of overloading should be supported.

=== What do you see instead? ===
It doesn't work, there is neither a specification in case anyone plans to implement it.

=== Additional information ===
Having thought about this, afaiu we can't follow Java's path of using "." for static methods/fields and "#" for instance methods/fields because of path-dependant types.

A thinkable worst-case could be something like this:

package Foo

class Foo {
  class Bar
  def Bar = 0
}
package Foo.Bar

class Bar
object Bar

Now add package objects on top of that.

It would be possible to use things like foo(Int,String) for overload resolution of methods, comparable to Java.

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Apr 19, 2011

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Apr 19, 2011

@soc said:
Also, coming up with a way to link to objects itself (without method call) would be nice.

{{scala.None}} is a good example. Maybe it would be possible to use the not-invented-yet char for object method/field access for differentiating between class/object? (If "@" would be the char, something like {{scala.None@}}?)

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Jul 20, 2012

@scabug scabug closed this Jul 20, 2012
@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Jul 23, 2012

@VladUreche said:
See #3695 for a quick tutorial on using links to members.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.