无法为重载方法创建ScalaDoc链接

Question

我遇到了ScalaDoc在使用重载时不接受方法链接的问题。

一个独立的例子：文件project/build.properties：

sbt.version=0.13.2 

文件build.sbt：

scalaVersion := "2.11.0" 

文件src/main/scala/Foo.scala：

package foobar 

/** @see [[Bar#foo]] 
    * @see [[Bar#bar]] 
    */ 
case class Foo() 

abstract class Bar { 
    def foo: Int 

    def bar: Foo 
    def bar(x: Option[Int]): Foo 
} 

当我运行sbt doc，该[[Bar#foo]]链接是好的，但该[[Bar#bar]]链接不被接受：

[warn] .../src/main/scala/Foo.scala:3: The link target "Bar#bar" is ambiguous. 
     Several members fit the target: 
[warn] (x: Option[Int]): foobar.Foo in class Bar [chosen] 
[warn] : foobar.Foo in class Bar 
[warn] 
[warn] 
[warn] Quick crash course on using Scaladoc links 
[warn] ========================================== 
[warn] Disambiguating terms and types: Prefix terms with '$' and types with '!' in case both names are in use: 
[warn] - [[scala.collection.immutable.List!.apply class List's apply method]] and 
[warn] - [[scala.collection.immutable.List$.apply object List's apply method]] 
[warn] Disambiguating overloaded members: If a term is overloaded, you can indicate the first part of its signature followed by *: 
[warn] - [[[scala.collection.immutable.List$.fill[A](Int)(⇒A):List[A]* Fill with a single parameter]]] 
[warn] - [[[scala.collection.immutable.List$.fill[A](Int,Int)(⇒A):List[List[A]]* Fill with a two parameters]]] 
[warn] Notes: 
[warn] - you can use any number of matching square brackets to avoid interference with the signature 
[warn] - you can use \\. to escape dots in prefixes (don't forget to use * at the end to match the signature!) 
[warn] - you can use \\# to escape hashes, otherwise they will be considered as delimiters, like dots. 
[warn] /** @see [[Bar#foo]] 
[warn]^
[warn] one warning found 

因此，使用了“速成班”，我尝试各种东西，如

[[Bar#bar:Foo*]] 
[[Bar!.bar:Foo*]] 
[[foobar.Bar!.bar:foobar.Foo*]] 

这一切都行不通。无论是使用其他重载的变体：

[[Bar#bar(Option[Int])]] 
[[Bar#bar(Option[Int]):Foo]] 
[[Bar!.bar(Option[Int]):Foo*]] 

因此，要么（像往常一样...）斯卡拉-doc的完全破裂，或者我做错了什么？

Answer 1

以下为我工作。使用完全限定的参数和返回类型，其中点的前缀为\。

[[Bar#bar:foobar\.Foo* The first bar method without argument]] 
[[Bar#bar(x:Option[Int]):foobar\.Foo* The second bar method with argument]] 

Answer 2

我试了一下：

package foobar 

/** @see [[Bar#foo]] 
    * @see [[Bar!.bar*]] 
    * @see [[[Bar!.bar(x:Option[Int])*]]] 
    */ 
case class Foo() 

abstract class Bar { 
    def foo: Int 

    def bar: Foo 
    def bar(x: Option[Int]): Foo 
} 

虽然我得到了同样的警告，被链接到两个栏方法生成的文档。

所以我想scala-doc不是完全是坏了......只是有点烦人。