DocUtil

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. def copyResource(path: String, out: File): Unit

   

   Copies the contents of a resource into a given file.

   Copies the contents of a resource into a given file.

   path

   the resource path (absolute)

   out

   the target file to write to

7. def defaultUnpackDir(baseDir: File, docModule: Module): File

   

8. def defaultUnpackDirBase(baseDir: File, groupId: String, artifactId: String): File

   

   The directory in which we would find the version sub-directories of a module.

9. def downloadAndExtract(docModule: Module, target: File, darkCss: Boolean = false, repoBase: URL = mavenCentral, deleteOnExit: Boolean = false)(implicit exec: ExecutionContext): (FileDownload, Future[Unit])

   

10. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

11. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

12. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

13. def findModuleVersions(docModule: Module, repoBase: URL = mavenCentral)(implicit exec: ExecutionContext): Future[Metadata]

    

    Reads the maven meta data for a documentation module.

    Reads the maven meta data for a documentation module. It only uses the groupId and artifactId and ignores the version, instead returning all found versions, sorted from newest to oldest.

14. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

15. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

16. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

17. def mavenCentral: URL

    

18. def mkJavadocDownloadUrl(docModule: Module, repoBase: URL = mavenCentral): URL

    

19. def mkJavadocMetaDataUrl(docModule: Module, repoBase: URL = mavenCentral): URL

    

20. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

21. final def notify(): Unit

    

    Definition Classes

    AnyRef

22. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

23. def setScalaCssStyle(dark: Boolean, baseDir: File): Unit

    

    Sets the scala-doc CSS files to either dark or light skin.

    Sets the scala-doc CSS files to either dark or light skin.

    dark

    true for dark look, false for light look

    baseDir

    base directory of extracted java-docs. The CSS files will be placed inside the lib directory in baseDir

24. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

25. def toString(): String

    

    Definition Classes

    AnyRef → Any

26. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

27. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

28. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )