Version

case class Version(displayValue: String, pathSegment: String, fallbackLink: String, label: Option[String], canonical: Boolean)

Configuration for a single version of the documentation.

Value parameters:
canonical

indicates whether this is the canonical version

displayValue

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

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)

pathSegment

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

Companion:
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Inherited methods

def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product