scaladoc
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
scaladoc/dotty.tools.scaladoc.renderers/Renderer

Renderer

dotty.tools.scaladoc.renderers.Renderer
abstract class Renderer(rootPackage: Member, val members: Map[DRI, Member], val extension: String)(using ctx: DocContext) extends SiteRenderer with Resources with Locations with Writer

Attributes

Graph
Supertypes
trait Resources
trait Writer
trait Locations
class Object
trait Matchable
class Any
Known subtypes

Members list

Concise view

Value members

Abstract methods

def pageContent(page: Page, parents: Vector[Link]): AppliedTag

Handler to prepare the content to be rendered. It's a good place to organize frame, footers, front-matter, etc.

Handler to prepare the content to be rendered. It's a good place to organize frame, footers, front-matter, etc.

Attributes

Concrete methods

def render(): Unit

Main method rendering all the pages

Main method rendering all the pages

Attributes

def renderPage(page: Page, parents: Vector[Link]): Seq[String]

Method to be overriden by concrete renderer to render single page

Method to be overriden by concrete renderer to render single page

Attributes

Inherited methods

def absolutePath(dri: DRI, extension: String): String

Attributes

Inherited from:
Locations
def allResources(pages: Seq[Page]): Seq[Resource]

Attributes

Inherited from:
Resources
def copy(from: InputStream, to: String): String

Attributes

Inherited from:
Writer
def copy(from: Path, to: String): String

Attributes

Inherited from:
Writer
def driExists(dri: DRI): Boolean

Attributes

Inherited from:
Locations
def escapedAbsolutePathWithAnchor(dri: DRI, extension: String): String

Attributes

Inherited from:
Locations
def linkResources(dri: DRI, resources: Iterable[String], deferJs: Boolean): Iterable[AppliedTag]

Attributes

Inherited from:
Resources
def pathToPage(from: DRI, to: DRI): String

Attributes

Inherited from:
Locations
def pathToRaw(from: Seq[String], to: Seq[String]): String

Attributes

Inherited from:
Locations
def pathToRoot(dri: DRI): String

Attributes

Inherited from:
Locations
def rawLocation(dri: DRI): Seq[String]

Attributes

Inherited from:
Locations
def relativeInternalOrAbsoluteExternalPath(dri: DRI): String

Attributes

Inherited from:
Locations
def renderResource(resource: Resource): Seq[String]

Attributes

Inherited from:
Resources
def resolveRoot(dri: DRI, path: String): String

Attributes

Inherited from:
Locations
def resolveRoot(from: Seq[String], to: String): String

Attributes

Inherited from:
Locations
def scastieConfiguration(): Resource

Attributes

Inherited from:
Resources
def searchData(pages: Seq[Page]): Resource

Attributes

Inherited from:
Resources
def siteContent(pageDri: DRI, content: ResolvedTemplate): PageContent

Attributes

Inherited from:
SiteRenderer
def templateToPage(t: LoadedTemplate, staticSiteCtx: StaticSiteContext): Page

Attributes

Inherited from:
SiteRenderer
def write(path: String, content: String): String

Attributes

Inherited from:
Writer
def write(dri: DRI, content: AppliedTag, extension: String): String

Attributes

Inherited from:
Writer

Concrete fields

val allPages: Seq[Page]

Here we have to retrive index pages from hidden pages and replace fake index pages in navigable page tree.

Here we have to retrive index pages from hidden pages and replace fake index pages in navigable page tree.

Attributes

Inherited fields

val apiOnlyResources: List[Resource]

Attributes

Inherited from:
Resources
val apiOnlyResourcesPaths: Seq[String]

Attributes

Inherited from:
Resources
lazy val apiPaths: Set[String]

Attributes

Inherited from:
Locations
var cache: HashMap[DRI, Seq[String]]

Attributes

Inherited from:
Locations
val commonResources: Seq[Resource]

Attributes

Inherited from:
Resources
val commonResourcesPaths: Seq[String]

Attributes

Inherited from:
Resources
lazy val darkProjectLogo: Option[Resource]

Attributes

Inherited from:
Resources
val earlyCommonResourcePaths: Seq[String]

Attributes

Inherited from:
Resources
val earlyCommonResources: Seq[Resource]

Attributes

Inherited from:
Resources
val onlyRenderedResources: Seq[Resource]

Attributes

Inherited from:
Resources
lazy val projectLogo: Option[Resource]

Attributes

Inherited from:
Resources
val scastieConfigurationPath: String

Attributes

Inherited from:
Resources
val searchDataPath: String

Attributes

Inherited from:
Resources
val staticSiteOnlyResources: List[Resource]

Attributes

Inherited from:
Resources
val staticSiteOnlyResourcesPaths: Seq[String]

Attributes

Inherited from:
Resources
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL