Scala Programming Language
  1. Scala Programming Language
  2. SI-3695

support non-fully-qualified type links in scaladoc comments

    Details

    • Type: Improvement Improvement
    • Status: Open
    • Priority: Critical Critical
    • Resolution: Unresolved
    • Affects Version/s: Scala 2.10.3, Scala 2.11.0
    • Fix Version/s: None
    • Component/s: Scaladoc Tool
    • Labels:

      Description

      Given that scala has powerful imports, plus we can rename/alias types, it would be great if we could just use the same name/expression for types in scaladoc comments as we use in the code - rather than having to use fully qualified names in link.

      e.g.

      /** something [[List]] */
      

      rather than

      /** something [[scala.collection.immutable.List]] */
      

        Issue Links

          Activity

          Hide
          Vlad Ureche added a comment -

          Bruno, try `A.nice(s:String)` (no spaces). I reopened the bug because it should give the error message and it should accept spaces.
          Eric, no, it's not possible to link to the constructor. Link to the class instead. Or open a bug for this.

          Show
          Vlad Ureche added a comment - Bruno, try `A.nice(s:String)` (no spaces). I reopened the bug because it should give the error message and it should accept spaces. Eric, no, it's not possible to link to the constructor. Link to the class instead. Or open a bug for this.
          Hide
          Vlad Ureche added a comment -

          Issues that need solving:

          • tutorial doesn't appear
          • spaces should be accepted in links
          Show
          Vlad Ureche added a comment - Issues that need solving: tutorial doesn't appear spaces should be accepted in links
          Hide
          Adriaan Moors added a comment -

          Could you set the fix-by version to something in the future?

          The most important fields for planners: assignee, affected version, fix-by versions.
          Issues that are unassigned and have no fix-by version are considered "unread".
          When an issue is read, it should be: assigned || (scheduled for an upcoming release || marked as fix-by backlog).

          Fix by backlog means we're not planning to work on this in the near future.

          Show
          Adriaan Moors added a comment - Could you set the fix-by version to something in the future? The most important fields for planners: assignee, affected version, fix-by versions. Issues that are unassigned and have no fix-by version are considered "unread". When an issue is read, it should be: assigned || (scheduled for an upcoming release || marked as fix-by backlog). Fix by backlog means we're not planning to work on this in the near future.
          Hide
          Eric Pederson added a comment -

          Done - SI-8067. Thanks!

          Show
          Eric Pederson added a comment - Done - SI-8067 . Thanks!
          Hide
          Bruno Bieth added a comment -

          None of the three work:

          method-link.scala:10: warning: Could not find any member to link for "A.nice(String)".
            /**
            ^
          method-link.scala:18: warning: Could not find any member to link for "A.nice(s:".
            /**
            ^
          method-link.scala:26: warning: Could not find any member to link for "A.nice(s:String)".
            /**
            ^
          three warnings found
          
          Show
          Bruno Bieth added a comment - None of the three work: method-link.scala:10: warning: Could not find any member to link for "A.nice(String)". /** ^ method-link.scala:18: warning: Could not find any member to link for "A.nice(s:". /** ^ method-link.scala:26: warning: Could not find any member to link for "A.nice(s:String)". /** ^ three warnings found

            People

            • Assignee:
              Unassigned
              Reporter:
              James Strachan
              TracCC:
              Johannes Rudolph
            • Votes:
              4 Vote for this issue
              Watchers:
              12 Start watching this issue

              Dates

              • Created:
                Updated:

                Development