suggestion for scaladoc related to Enumeration.value

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

suggestion for scaladoc related to Enumeration.value

Grzegorz Balcerek
Hello,
 
I would like to make a suggestion regarding scaladoc (2.8)
 
Example: The scaladoc entry for the class BorderPanel shows the following:
 
Type Members
  type Constraints = Value
 
When the cursor is moved over "Value", the following information shows up: "scala.Enumeration.Value".
 
By looking at the source file BorderPanel.scala one can find the following:
  object Position extends Enumeration {
  (...)
  type Constraints = Position.Value
 
It would be nice if I could find the information that the Value is related to BorderPanel.Position by looking at the scaladoc entry related to the BorderPanel class, without going into the source file.
So, the suggestion is to show that information somewhere in the scaladoc entry.
Regards,
Grzegorz
Reply | Threaded
Open this post in threaded view
|

Re: suggestion for scaladoc related to Enumeration.value

Ken Scambler
+1
I really have to agree with this one -- just showing "Value" is not at all useful.  It's not just Enumeration though -- it's really about showing the full path of path-dependent types in scaladoc.  I can't think of any reason why this couldn't be done, but smarter folk than me might know more.

Ken



2010/10/16 Grzegorz Balcerek <[hidden email]>
Hello,
 
I would like to make a suggestion regarding scaladoc (2.8)
 
Example: The scaladoc entry for the class BorderPanel shows the following:
 
Type Members
  type Constraints = Value
 
When the cursor is moved over "Value", the following information shows up: "scala.Enumeration.Value".
 
By looking at the source file BorderPanel.scala one can find the following:
  object Position extends Enumeration {
  (...)
  type Constraints = Position.Value
 
It would be nice if I could find the information that the Value is related to BorderPanel.Position by looking at the scaladoc entry related to the BorderPanel class, without going into the source file.
So, the suggestion is to show that information somewhere in the scaladoc entry.
Regards,
Grzegorz