Packages

class ServerConfig extends AnyRef

Additional configuration options for a preview server.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerConfig
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. val apiDir: Option[FilePath]
  5. val artifactBasename: String
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. val host: Host
  13. val includeEPUB: Boolean
  14. val includePDF: Boolean
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val isVerbose: Boolean
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. val pollInterval: FiniteDuration
  21. val port: Port
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def verbose: ServerConfig

    Indicates that each served page and each detected file change should be logged to the console.

  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def withAPIDirectory(dir: FilePath): ServerConfig

    Specifies a directory from which API documentation of the site can be served.

    Specifies a directory from which API documentation of the site can be served. This step is only necessary if you want to test links to API documentation with the preview server.

  29. def withArtifactBasename(name: String): ServerConfig

    Specifies the base name for PDF and EPUB artifacts linked by the generated site (default "docs").

    Specifies the base name for PDF and EPUB artifacts linked by the generated site (default "docs"). Additional classifiers might be added to the base name (apart from the file suffix), depending on configuration.

  30. def withEPUBDownloads: ServerConfig

    Indicates that EPUB downloads should be included on the download page.

  31. def withHost(host: Host): ServerConfig

    Specifies the host the server should run on (default localhost).

  32. def withPDFDownloads: ServerConfig

    Indicates that PDF downloads should be included on the download page.

  33. def withPollInterval(interval: FiniteDuration): ServerConfig

    Specifies the interval at which input file resources are polled for changes (default 1 second).

  34. def withPort(port: Port): ServerConfig

    Specifies the port the server should run on (default 4242).

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def withAPIDirectory(dir: File): ServerConfig
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) use withAPIDirectory(FilePath)

Inherited from AnyRef

Inherited from Any

Ungrouped