代码之家  ›  专栏  ›  技术社区  ›  Jake

scalaDoc:排除方法

  •  0
  • Jake  · 技术社区  · 6 年前

    我正在使用maven生成scaladocs(见下文)

    问题: 我有一些实用特性。它们的方法是公共的,因为我想将它们混合到任何类中(典型的函数是字符串操作等)。 然而,scalaDoc将这些方法与混合了这些实用特性的任何类的公共接口方法包含在一起。因此,除了看到 someVeryUsefulMethod(value:Int) ,scala文档也发布 someTrivialStringManipulation(s:String)

    问题: 除了更改不需要的方法的作用域之外,如何从scaladoc中排除它们?

    <plugin>
            <groupId>org.scala-tools</groupId>
            <artifactId>maven-scala-plugin</artifactId>
            <executions>
                <execution>
                    <id>Scaladoc</id>
                    <goals>
                        <goal>doc</goal>
                    </goals>
                    <phase>prepare-package</phase>
                    <configuration>
                        <args>
                            <arg>-no-link-warnings</arg>
                        </args>
                    </configuration>
                </execution>
    1 回复  |  直到 6 年前
        1
  •  0
  •   Jake    6 年前

    好吧,答案显而易见。只需在特征方法上使用包范围。然后,它们将始终对使用它们的类可见,但从未在scaladoc中打印。

    推荐文章