scaladoc/dotty.tools.scaladoc.renderers/Renderer

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
trait Resources
trait Writer
trait Locations
class Object
trait Matchable
class Any

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.

Concrete methods

def render(): Unit

Main method rendering all the pages

Main method rendering all the pages

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

Inherited methods

def absolutePath(dri: DRI, extension: String): String
Inherited from:
Locations
def allResources(pages: Seq[Page]): Seq[Resource]
Inherited from:
Resources
def copy(from: InputStream, to: String): String
Inherited from:
Writer
def copy(from: Path, to: String): String
Inherited from:
Writer
def driExists(dri: DRI): Boolean
Inherited from:
Locations
def escapedAbsolutePathWithAnchor(dri: DRI, extension: String): String
Inherited from:
Locations
def linkResources(dri: DRI, resources: Iterable[String], deferJs: Boolean): Iterable[AppliedTag]
Inherited from:
Resources
def pathToPage(from: DRI, to: DRI): String
Inherited from:
Locations
def pathToRaw(from: Seq[String], to: Seq[String]): String
Inherited from:
Locations
def pathToRoot(dri: DRI): String
Inherited from:
Locations
def rawLocation(dri: DRI): Seq[String]
Inherited from:
Locations
def renderResource(resource: Resource): Seq[String]
Inherited from:
Resources
def resolveRoot(dri: DRI, path: String): String
Inherited from:
Locations
def resolveRoot(from: Seq[String], to: String): String
Inherited from:
Locations
def searchData(pages: Seq[Page]): Resource
Inherited from:
Resources
def siteContent(pageDri: DRI, content: ResolvedTemplate): PageContent
Inherited from:
SiteRenderer
def templateToPage(t: LoadedTemplate, staticSiteCtx: StaticSiteContext): Page
Inherited from:
SiteRenderer
def write(path: String, content: String): String
Inherited from:
Writer
def write(dri: DRI, content: AppliedTag, extension: String): String
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.

Inherited fields

lazy val apiPaths: Set[String]
Inherited from:
Locations
var cache: HashMap[DRI, Seq[String]]
Inherited from:
Locations
val searchDataPath: String
Inherited from:
Resources