2015-09-16 66 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

這是相當複雜的,但它回答了這個要求。

相關問題