scaladoc: исключить методы - PullRequest
       32

scaladoc: исключить методы

0 голосов
/ 13 октября 2018

Я использую maven для генерации скалярных документов (см. Ниже)

Проблема: У меня есть некоторые полезные черты.Их методы общедоступны, так как я хочу смешать их с любыми классами (типичными функциями являются манипуляции со строками и т. Д.).Scaladoc, однако, включает методы с методами открытого интерфейса любого класса, который смешивает эти служебные черты.Следовательно, помимо просмотра скалярного документа для someVeryUsefulMethod(value:Int), документ Scala также публикует someTrivialStringManipulation(s:String)

Вопрос: Как исключить нежелательные методы из скалярного документа, кроме изменения их области действия?

<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 Ответ

0 голосов
/ 13 октября 2018

ОК, ответ был тупо очевиден.Просто используйте область видимости для методов черты.Тогда они всегда будут видны классам, которые их используют, но никогда не будут напечатаны в scaladoc

...