标签: scaladoc

在Eclipse中我已经设置了的Javadoc位置我的斯卡拉项目的物业file:/D:/EclipseWorkspace/MyProject/target/scala-2.9.1/api那里D:/EclipseWorkspace/MyProject是我的斯卡拉项目的位置.

现在,如果我在实现类/特征的Scala文件中,当我键入Shift+时F2,Eclipse将打开该类/特征的Scaladoc页面.但是,如果它是一个对象,则这不起作用,因为Eclipse尝试打开<ObjectName>.html而Scaladoc生成的文件名是<ObjectName>$.html.

有没有解决方法？

将以下设置添加到build.sbtPlay 2.2.x应用程序的文件不会禁用Scaladoc生成.怎么可以禁用？

play.Project(appName, appVersion, appDependencies)
    .settings(scalaVersion := "2.10.3")
    .settings(jsSettings : _*)
    .settings(
        publishArtifact in (Compile, packageDoc) := false,
        publishArtifact in packageDoc := false
    )

我正在使用重载方法记录Scala类.在scaladoc注释中引用它们时如何区分它们？例如,如果我有

/**
 * The most important method is [[Doc.foo]].
 */
object Doc {
  def foo[A]: A = throw new UnsupportedOperationException;
  def foo[A,B >: A](x: A): B = x;
}

sbt doc我跑了

Doc.scala:1:警告:链接目标"Doc.foo"不明确.几个(可能是超载的)成员符合目标:

• foo[A,B>:A](x:A):B对象Doc中的方法[已选择]
• foo[A]:Nothing对象Doc中的方法

使用foo[A,B >: A]等链接不起作用.

我为scaladoc 2.0教程或示例进行了bin或google搜索,我找不到任何东西,实际上甚至没有链接到官方scaladoc 2.0文档.谁知道在哪里找到一个？

从Scala 2.10.2开始,我找不到其API文档的下载链接.这是故意遗漏吗？我在哪里可以下载？

或者,scalac使用http://www.scala-lang.org/api/current/index.html生成相同命令的确切命令是什么？(例如,我不知道我必须包括哪些来源罐.)

我正在尝试将JDK中的类链接到scaladoc生成的doc中.我使用了-doc-external-docscaladoc 2.10.1 的选项,但没有成功.

我正在使用-doc-external-doc:/usr/lib/jvm/java-7-openjdk-amd64/jre/lib/rt.jar#http://docs.oracle.com/javase/7/docs/api/,但我得到的链接index.html#java.io.File不是index.html?java/io/File.html.似乎此选项仅适用于scaladoc生成的doc.

我是否错过了scaladoc中的选项,还是应该填写功能请求？

我已经配置sbt如下:

 scalacOptions in (Compile,doc) += "-doc-external-doc:/usr/lib/jvm/java-7-openjdk-amd64/jre/lib/rt.jar#http://docs.oracle.com/javase/7/docs/api"

注意:我Opts.doc.externalAPI在即将到来的sbt 0.13中看到过util.我认为一个很好的补充(不确定是否可能)将是传递ModuleID而不是File.util会找出哪个文件对应于ModuleID.

我试图找到Scala运算符方法的文档#::.我相信它是在Stream类中定义的,因为我发现使用它的一个例子.

我的问题并不特别针对这种方法(虽然我想知道文档的位置),但是如何一般地搜索Scala文档.我尝试进入#::文档页面左上角的搜索框(2.8.1),但没有找到任何内容.

我是否有可能通过scala doc在全局范围内搜索类,特征或对象中的方法？示例:我有一个方法名称,我不知道它属于哪个类,所以我可以在一些scaladoc搜索中键入它,它将显示包含具有给定名称的方法的类.(PS:我会添加标签scaladoc,但显然我不配......)

我试图跑sbt test:doc,我看到一些类似于下面的警告:

[警告] /Users/tleese/code/my/stuff/src/test/scala/com/my/stuff/common/tests/util/NumberExtractorsSpecs.scala:9:找不到任何能为"com.my"链接的成员.stuff.common.util.IntExtractor".

问题似乎是从测试源到主要源的Scaladoc引用无法正确链接.知道我可能做错了什么或需要配置什么？

以下是我的Build.scala的相关部分:

val docScalacOptions = Seq("-groups", "-implicits", "-external-urls:[urls]")

scalacOptions in (Compile, doc) ++= docScalacOptions
scalacOptions in (Test, doc) ++= docScalacOptions
autoAPIMappings := true

为什么Scaladoc中的一些方法描述开始于[use case]？

例: scala.collection.immutable.StringOps.++

它只是一个将来被替换的占位符吗？