specs2-html/org.specs2.html/Index

Index

object Index
Companion
class
trait Product
trait Mirror
class Object
trait Matchable
class Any

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from
Mirror

Value members

Concrete methods

def page(entry: IndexEntry): String
def pages(index: Index): Seq[String]
def sanitizeEntry(entry: IndexEntry): String

the text that is used for indexing must be sanitized:

the text that is used for indexing must be sanitized:

  • no newlines
  • ^ (because tipue search doesn't like it)
  • no markdown characters
def toJson(index: Index): String

Concrete fields

val empty: Index

Givens

Givens

given given_Monoid_Index: Monoid[Index]