2

我的伴侣对象(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".

我将如何添加该def apply(p: ResultName[Product])(rs: WrappedResultSet): Product方法的链接?

4

1 回答 1

4

所以这就是我发现的:

  1. 一切都必须完全合格,甚至是类/对象本身

  2. 包点应该用 \ 转义

  3. 您不能在签名中使用任何空格

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

  5. 签名应以 * 结尾

最后这工作:

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

但是...反斜杠转义和 * 也出现在生成的 html 中!

为 scaladoc 生成的 html

于 2016-03-23T21:46:15.257 回答