scaladoc/dotty.tools.scaladoc.renderers/HtmlRenderer

HtmlRenderer

class HtmlRenderer(rootPackage: Member, members: Map[DRI, Member])(using ctx: DocContext) extends Renderer
class Renderer
trait Resources
trait Writer
trait Locations
class Object
trait Matchable
class Any

Value members

Concrete methods

def mkHead(page: Page): AppliedTag
override def pageContent(page: Page, parents: Vector[Link]): AppliedTag
Definition Classes
override def render(): Unit
Definition Classes

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 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 renderContent(page: Page): AppliedTag
Inherited from:
Renderer
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 from:
Renderer
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): AppliedTag
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

Inherited 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 from:
Renderer
lazy val apiPaths: Set[String]
Inherited from:
Locations
var cache: HashMap[DRI, Seq[String]]
Inherited from:
Locations
val effectiveMembers: Map[DRI, Member]
Inherited from:
Renderer
val hiddenPages: Seq[Page]
Inherited from:
Renderer
val searchDataPath: String
Inherited from:
Resources