链接到[[importedName]],而不是scaladoc

时间:2015-09-16 10:03:29

标签: scala reference scaladoc

如何在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)

但我不想加入文档[[com.pany.pck1.subpck.Class1]]

如果有必要,我不介意在Class2 doc的末尾添加引用,例如

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

1 个答案:

答案 0 :(得分:1)

我找到了一种方法,使用@$('.btn-filter.active').not(".btn-filter.#{filter.status}").removeClass('active') @$(".btn-filter.#{filter.status}").addClass('active')

档案1

@define

文件2

package com.pany.pck1.subpck
class Class1

所以基本上,define用于创建一个宏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) ,它由链接Class1取代:[[com.pany.pck1.subpck.Class1 Class1]]的链接显示为com.pany.pck1.subpck.Class1。< / p>

这很复杂,但它符合要求。