2015-09-16 60 views
0

如何在scaladoc中链接到某个导入的名称(位于另一个包中),而无需使用完全限定名称?链接到[[importedName]],而不是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中文档的最后一个引用,如

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

回答

0

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

文件1

package com.pany.pck1.subpck 
class Class1 

file 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) 

所以基本上,定义用于创建一个宏Class1,它被链接[[com.pany.pck1.subpck.Class1 Class1]]取代:指向com.pany.pck1.subpck.Class1的链接显示为Class1

这是相当复杂的,但它回答了这个要求。

相关问题