Scaladoc link 到另一个方法

Scaladoc link to another method

我的伴随对象 (model.Product) 有两个方法:

def apply(p:ProductSyntax)(rs: WrappedResultSet): Product
def apply(p: ResultName[Product])(rs: WrappedResultSet): Product

第一个方法委托给第二个方法,我想在文档中指出这一点。我尝试使用:

/**
 * delegates to [[apply]]
 * /

但是 scaladoc 抱怨说这是模棱两可的,但告诉我

(p: scalikejdbc.ResultName[model.Product])(rs: scalikejdbc.WrappedResultSet): model.Product in object Product

是一个选项

但是我不知道如何告诉 scaladoc 使用这个方法。我试过了

/**
 * Delegates to [[apply(scalikejdbc.ResultName[model.Product])(scalikejdbc.WrappedResultSet):model.Product]]
 * /

但是它告诉我没有找到成员:

Could not find any member to link for "apply(scalikejdbc.ResultName[model.Product])(scalikejdbc.WrappedResultSet):model.Product".

如何将 link 添加到 def apply(p: ResultName[Product])(rs: WrappedResultSet): Product 方法?

这就是我的发现:

  1. 一切都必须完全合格,甚至 class/object 本身

  2. 包点应该用\

  3. 转义
  4. 签名中不能使用任何空格

  5. 参数应包括名称而不仅仅是类型,即 foo(a:String) 而不是 foo(String)

  6. 签名应以 *

  7. 结尾

终于成功了:

[[apply(p:scalikejdbc\.ResultName[model\.Product])(rs:scalikejdbc\.WrappedResultSet):model\.Product*]]

然而 ... 反斜杠转义和 * 也出现在生成的 html!