【问题标题】:Scaladoc from IDEA or Maven来自 IDEA 或 Maven 的 Scaladoc
【发布时间】:2014-05-24 15:39:50
【问题描述】:

我正在使用 Maven 进行构建,并使用带有 Scala 插件的 IntelliJ IDEA。使用我的 pom.xml 中的 Scala 2.10.3 依赖项,该项目可以正常运行和调试。

但是当我尝试使用 IDEA 从我的整个项目中生成 Scaladocs 时,它实际上什么也没做,没有输出。

相关,我也想从 Maven 生成 Scaladocs。我已经为项目的 java 部分准备了 Javadocs。有使用 sbt 执行此操作的说明,但我找不到有关使用 Maven 执行此操作的说明。

我的 IDEA 项目有以下 Scala 库

scala-library-2.10.3.jar
scala-reflect-2.10.0.jar
scalatest_2.10-2.0.jar

【问题讨论】:

    标签: scala maven intellij-idea scaladoc


    【解决方案1】:

    您必须添加 maven 插件才能拥有 scala 文档。将以下代码添加到您的 pom.xml

    <project>
    
     <reporting>
    <plugins>
      ...
      <plugin>
        <groupId>org.scala-tools</groupId>
        <artifactId>maven-scala-plugin</artifactId>
      </plugin>
      ...
    </plugins>
    

    并将 scala 源文件放入:

    src/main/scala
    

    之后使用以下 maven 目标:

    # generate a site
    mvn site
    

    # generate only the doc
    mvn scala:doc
    

    文档结果将位于:

    target/site/scaladocs/
    

    尝试以下链接了解更多详情: http://scala-tools.org/mvnsites/maven-scala-plugin/usage_doc.html

    【讨论】:

    • 解决了maven scaladocs,我有插件,只是不知道CLI。
    • 很好的答案!一般适用于从 Java 移植到 Scala。
    猜你喜欢
    • 2014-12-26
    • 2012-05-12
    • 1970-01-01
    • 1970-01-01
    • 2016-04-14
    • 2012-10-20
    • 2011-03-28
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多