0

如何在 scaladoc 中创建指向某些导入名称(在另一个包中)的链接,而不必使用完全限定名称?

例子:

文件 1

package com.pany.pck1.subpck
class Class1

文件 2

package com.pany.pck2.othersubpck
import com.pany.pck1.subpck.Class1

/**
 * Use a [[Class1]]
 */
case class Class2(c1: Class1)

但我不想在 doc 中有[[com.pany.pck1.subpck.Class1]]

如有必要,我不介意在 Class2 文档末尾添加 ref,例如

/**
 * ...
 * [Class1= com.pany.pck1.subpck.Class1]
 */
4

1 回答 1

1

我找到了一种方法,使用@define

文件 1

package com.pany.pck1.subpck
class Class1

文件 2

package com.pany.pck2.othersubpck
import com.pany.pck1.subpck.Class1

/**
 * Use a $Class1
 *
 * @define Class1 [[com.pany.pck1.subpck.Class1 Class1]]
 */
case class Class2(c1: Class1)

所以基本上,define 用于创建一个 Macro Class1,它被链接替换[[com.pany.pck1.subpck.Class1 Class1]]:指向该链接的链接com.pany.pck1.subpck.Class1显示为Class1.

这非常令人费解,但它满足了要求。

于 2015-09-16T11:49:48.403 回答