Type Members

1.  case class ApiLinks(baseUri: String, packagePrefix: String = "*", packageSummary: String = "index.html") extends Product with Serializable
2.  case class DocumentTargets(document: Document, slugBuilder: (String) ⇒ String) extends Product with Serializable

   Collects all tree elements from a document that can be referenced from other elements, like images, footnotes, citations and other inline targets.

3.  case class IconRegistry(icons: Map[String, Icon]) extends Product with Serializable

   Registers Icon AST elements for use with the @:icon directive and the IconReference AST element.

4.  case class InvalidTarget(message: String) extends TargetValidation with Product with Serializable
5.  case class LinkAliasResolver(sourceSelector: TargetIdSelector, targetSelector: TargetIdSelector, referenceResolver: (LinkSource) ⇒ Option[Span], formats: TargetFormats) extends TargetResolver with Product with Serializable
6.  case class LinkConfig(targets: Seq[TargetDefinition] = Nil, excludeFromValidation: Seq[Path] = Nil, apiLinks: Seq[ApiLinks] = Nil, sourceLinks: Seq[SourceLinks] = Nil) extends Product with Serializable

7.  case class LinkDefinitionSelector(id: String) extends UniqueSelector with Product with Serializable

   A selector for a definition for an internal or external link.

8.  class LinkResolver extends RewriteRulesBuilder

   The default rewrite rules responsible for resolving link references that get applied to the raw document tree after parsing.

   The default rewrite rules responsible for resolving link references that get applied to the raw document tree after parsing.

   These rules resolve references to images, footnotes, citations and other inline targets, and generate the identifiers for targets with auto-generated ids like auto-number footnotes.

   The rules replace references pointing to internal or external targets with the corresponding resolved link elements, as well as the targets themselves with nodes that contain their final ids.

   In case of duplicate target ids or unresolvable references runtime messages get inserted into the final document tree.

9.  case class LinkSource(span: Span, path: Path) extends Product with Serializable

   Represents the source of a link, its document path and the actual inline span that is representing the link.

10.  sealed trait LinkValidation extends AnyRef

    Represents configuration options for link validation.

11.  case class PathSelector(path: Path) extends UniqueSelector with Product with Serializable

    A selector based on a path, optionally including a fragment component.

12.  case class RecoveredTarget(message: String, recoveredTarget: ResolvedInternalTarget) extends TargetValidation with Product with Serializable
13.  sealed trait Selector extends AnyRef

    Represents a selector used for matching reference nodes to target nodes.

    Represents a selector used for matching reference nodes to target nodes. The selectors often differ from both, the ids rendered in the final document and the ids used for display.

14.  sealed trait SequenceSelector extends Selector

    A selector that can be used for a sequence of targets.

15.  case class SourceLinks(baseUri: String, suffix: String, packagePrefix: String = "*") extends Product with Serializable
16.  case class TargetDefinition(id: String, target: Target) extends Product with Serializable
17.  case class TargetIdSelector(id: String) extends UniqueSelector with Product with Serializable

    A selector for a rendered target in a document.

18.  sealed abstract class TargetResolver extends AnyRef

    Represents a resolver for a target that has its final identifier generated (if necessary) and can be used to resolve matching reference nodes.

19.  case class TargetSequenceResolver(targets: Seq[TargetResolver], sel: Selector) extends TargetResolver with Product with Serializable

    Represents a resolver for a sequence of targets where matching reference nodes get determined by position.

    Represents a resolver for a sequence of targets where matching reference nodes get determined by position. The resolveReference and resolveTarget methods can be invoked as many times as this sequence contains elements.

20.  sealed trait TargetValidation extends AnyRef
21.  class TreeTargets extends AnyRef

    Collects all elements from a document tree that can be referenced from other elements, like images, footnotes, citations and other inline targets.

22.  sealed trait UniqueSelector extends Selector

    A selector that can is a globally unique identifier.