Index

org.specs2.html.Index
See theIndex companion class
object Index

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Index.type

Members list

Type members

Classlikes

object given_Monoid_Index extends Monoid[Index]

Attributes

Supertypes
trait Monoid[Index]
trait Semigroup[Index]
class Object
trait Matchable
class Any
Self type

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

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

Attributes

def toJson(index: Index): String

Concrete fields

val empty: Index

Givens