case class Version(displayValue: String, pathSegment: String, fallbackLink: String = "index.html", label: Option[String] = None, canonical: Boolean = false) 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
orStable
)- canonical
indicates whether this is the canonical version
- Alphabetic
- By Inheritance
- Version
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Version(displayValue: String, pathSegment: String, fallbackLink: String = "index.html", label: Option[String] = None, canonical: Boolean = false)
- 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
orStable
)- canonical
indicates whether this is the canonical version
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val canonical: Boolean
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
- val displayValue: String
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val fallbackLink: String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val label: Option[String]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val pathSegment: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated