如何将 Maven 配置为在 scaladoc 报告中使用“rootdoc.txt”？

Question

我知道如何通过 SBT：Where does scaladoc look for the rootdoc.txt to create the root doc 执行此操作，但无法使用 Maven 解决。由于 SBT 存在缺陷，我无法将 SBT 用于一般构建。

在http://davidb.github.io/scala-maven-plugin/example_doc.html 之后，我的 pom.xml 中有以下内容

        <plugin>
            <groupId>net.alchim31.maven</groupId>
            <artifactId>scala-maven-plugin</artifactId>
            <version>3.4.4</version>
            <executions>
                <execution>
                    <configuration>
                        <args>
                            <arg>-doc-root-content rootdoc.txt</arg>
                        </args>
                        <jvmArgs>
                            <jvmArg>-Xms1024m</jvmArg>
                            <jvmArg>-Xmx4096m</jvmArg>
                        </jvmArgs>
                    </configuration>
                </execution>
            </executions>
        </plugin>

和

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>3.0</version>
            <configuration>
                <reportPlugins>
                    <plugin>
                        <artifactId>maven-project-info-reports-plugin</artifactId>
                        <version>2.2</version>
                    </plugin>
                    <plugin>
                        <groupId>net.alchim31.maven</groupId>
                        <artifactId>scala-maven-plugin</artifactId>
                        <version>3.4.4</version>
                        <configuration>
                            <args>
                                <arg>-doc-root-content rootdoc.txt</arg>
                            </args>
                            <jvmArgs>
                                <jvmArg>-Xms64m</jvmArg>
                                <jvmArg>-Xmx1024m</jvmArg>
                            </jvmArgs>
                        </configuration>
                    </plugin>
                    ...
                </reportPlugins>
            </configuration>
        </plugin>

包含 API Docs 的根文档会非常好，而不必使用 SBT 来生成文档。

Answer 1

<arg> 应该只包含一个参数，而不是 2 个。 试试看

                    <args>
                        <arg>-doc-root-content<arg>
                        <arg>rootdoc.txt</arg>
                    </args>

注意：同上 SBT 有 2 个字符串：

scalacOptions in Compile ++= Seq("-doc-root-content", "rootdoc.txt")

更新：

• 样本已更新https://github.com/davidB/scala-maven-plugin/blob/master/src/it/test_goal_doc/pom.xml
• 更多详情请访问https://github.com/davidB/scala-maven-plugin/issues/305