Packages

case class Version(displayValue: String, pathSegment: String, fallbackLink: String = "index.html", label: Option[String] = None) extends Product with Serializable

Configuration for a single version of the documentation.

displayValue

the description of the version to use in any UI (e.g. version dropdowns)

pathSegment

the string to use as a path segments in URLs pointing to this version

fallbackLink

the link target to use when switching to this version from a page that does not exist in this version

label

an optional label that will be used in the UI (e.g. Dev or Stable)

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Version
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Version(displayValue: String, pathSegment: String, fallbackLink: String = "index.html", label: Option[String] = None)

    displayValue

    the description of the version to use in any UI (e.g. version dropdowns)

    pathSegment

    the string to use as a path segments in URLs pointing to this version

    fallbackLink

    the link target to use when switching to this version from a page that does not exist in this version

    label

    an optional label that will be used in the UI (e.g. Dev or Stable)

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. val displayValue: String
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val fallbackLink: String
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val label: Option[String]
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. val pathSegment: String
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped