爲什麼Scalaz出現在我的項目的API文檔中？

Question

假設我的整個項目的配置是這樣的簡單build.sbt：

scalaVersion := "2.11.4" 

libraryDependencies += "org.scalaz" %% "scalaz-core" % "7.1.0" 

這是我的代碼：

import scalaz.Equal 
import scalaz.syntax.equal._ 

object Foo { 
    def whatever[A: Equal](a: A, b: A) = a === b 
} 

現在，當我運行sbt doc，並在瀏覽器中打開API文檔，我看到了scalaz封裝在ScalaDoc根包列表中，與我一起Foo：

object Foo 
package scalaz 

或者，如果你不相信我：

我已經與Scalaz前注意到這點，我不是它發生的唯一一個（例如見淘金的currently published version API文檔）。我不確定我是否看到除Scalaz之外的任何圖書館都會發生這種情況。

如果我實際上沒有在我的項目代碼中使用Scalaz中的任何內容，它不會顯示出來。至少在2.10.4和2.11.4發生同樣的事情。

爲什麼scalaz包出現在這裏，我該如何讓它停止？

Answer 1

我也注意到了這一點。它也發生在來自Akka的akka.pattern包以及例如upickle項目的upickle包中。

這三個包有兩個共同點：

1. 他們是包對象
2. 他們定義在一個混合特徵至少一種類型。

所以，我做了一個小實驗了兩個項目：

項目A：

trait SomeFunctionality { 
    class P(val s: String) 
} 

package object projectA extends SomeFunctionality 

項目B（依賴於項目A）：

package projectB 
import projectA._ 

object B extends App { 
    val p = new P("Test") 
} 

瞧：在項目B的ScalaDoc在根包中出現兩個包：

projectA 
projectB 

看起來上述兩個標準都必須得到滿足，因爲消除一個解決了這個問題。

我相信這是scala編譯器中的一個bug。所以我不能幫你避免這種情況，因爲唯一的辦法就是在這種情況下改變scalaz的來源。除了刪除對ProjectA的所有引用之外，更改ProjectB中的任何內容都無濟於事。

---

更新：好像你可以指示編譯器exclude specific packages from scaladoc。

scaladoc -skip-packages <pack1>:<pack2>:...:<packN> files.scala 

所以這將是這裏