scaladoc:排除方法
scaladoc: Exclude methods
我正在使用 maven 生成 scaladocs(见下文)
问题:
我有一些实用特征。它们的方法是 public,因为我想将它们混合到任何 class 中(典型的函数是字符串操作等)。
然而,Scaladoc 将方法包含在任何 class 的 public 接口方法中,这些方法混合了这些实用特性。因此,除了查看 someVeryUsefulMethod(value:Int)
的 scaladoc 外,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>
好的,答案非常明显。只需在特征方法上使用包范围。然后,它们将始终对使用它们的 类 可见,但绝不会在 scaladoc
中打印
我正在使用 maven 生成 scaladocs(见下文)
问题:
我有一些实用特征。它们的方法是 public,因为我想将它们混合到任何 class 中(典型的函数是字符串操作等)。
然而,Scaladoc 将方法包含在任何 class 的 public 接口方法中,这些方法混合了这些实用特性。因此,除了查看 someVeryUsefulMethod(value:Int)
的 scaladoc 外,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>
好的,答案非常明显。只需在特征方法上使用包范围。然后,它们将始终对使用它们的 类 可见,但绝不会在 scaladoc
中打印