Scaladoc链接到另一种方法

时间:2016-03-23 19:24:02

标签: scala scaladoc

我的伴侣对象(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方法的链接?

1 个答案:

答案 0 :(得分:2)

所以这就是我发现的:

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

  2. 应使用\

  3. 转义包装点
  4. 您不能在签名中使用任何空格

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

  6. 签名应以*

  7. 结尾

    最后这有效:

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

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

    Generated html for the scaladoc