abstract class HtmlPage extends Page
An html page that is part of a Scaladoc site.
- Self Type
- HtmlPage
- Source
- HtmlPage.scala
- Alphabetic
- By Inheritance
- HtmlPage
- Page
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new HtmlPage()
Abstract Value Members
-
abstract
def
body: NodeSeq
The body of this page.
-
abstract
def
docletReporter: Reporter
ScalaDoc reporter for error handling
ScalaDoc reporter for error handling
- Attributes
- protected
-
abstract
def
headers: NodeSeq
Additional header elements (links, scripts, meta tags, etc.) required for this page.
Additional header elements (links, scripts, meta tags, etc.) required for this page.
- Attributes
- protected
-
abstract
def
path: List[String]
The path of this page, relative to the API site.
The path of this page, relative to the API site.
path.tailis a list of folder names leading to this page (from closest package to one-above-root package),path.headis the file name of this page. Note thatpathhas a length of at least one.- Definition Classes
- Page
-
abstract
def
title: String
The title of this page.
The title of this page.
- Attributes
- protected
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (HtmlPage, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
absoluteLinkTo(path: List[String]): String
- Definition Classes
- Page
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def blockToHtml(block: Block): NodeSeq
- def bodyToHtml(body: Body): NodeSeq
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
commentToHtml(comment: Comment): NodeSeq
Transforms a comment into an styled HTML tree representing its body.
-
def
commentToHtml(comment: Option[Comment]): NodeSeq
Transforms an optional comment into an styled HTML tree representing its body if it is defined, or into an empty node sequence if it is not.
- def companionAndPackage(tpl: DocTemplateEntity): NodeSeq
-
def
createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream
- Definition Classes
- Page
-
def
description: String
The page description
The page description
- Attributes
- protected
- def docEntityImageClass(tpl: DocTemplateEntity): String
- def docEntityKindToCompanionTitle(ety: DocTemplateEntity, baseString: String = "See companion"): String
- def ensuring(cond: (HtmlPage) ⇒ Boolean, msg: ⇒ Any): HtmlPage
- def ensuring(cond: (HtmlPage) ⇒ Boolean): HtmlPage
- def ensuring(cond: Boolean, msg: ⇒ Any): HtmlPage
- def ensuring(cond: Boolean): HtmlPage
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hasCompanion(mbr: TemplateEntity): Boolean
- Definition Classes
- Page
- def hasPage(e: DocTemplateEntity): Boolean
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def inlineToHtml(inl: Inline): NodeSeq
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
keywords: String
The page keywords
The page keywords
- Attributes
- protected
-
def
kindToString(mbr: MemberEntity): String
- Definition Classes
- Page
- def linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean): NodeSeq
- def listItemsToHtml(items: collection.Seq[Block]): NodeSeq
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def permalink(template: Entity): Elem
-
def
relativeLinkTo(destPath: List[String]): String
A relative link from a page's path to some destination path.
A relative link from a page's path to some destination path.
- destPath
The path that the link will point to.
- Definition Classes
- Page
-
def
relativeLinkTo(destClass: TemplateEntity): String
A relative link from this page to some destination class entity.
A relative link from this page to some destination class entity.
- destClass
The class or object entity that the link will point to.
- Definition Classes
- Page
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
templateToHtml(tpl: TemplateEntity, name: String = null): Node with Serializable
Returns the HTML code that represents the template in
tplas a hyperlinked name. -
def
templateToPath(tpl: TemplateEntity): List[String]
- Definition Classes
- Page
-
def
templatesToHtml(tplss: List[TemplateEntity], sep: NodeSeq): NodeSeq
Returns the HTML code that represents the templates in
tplsas a list of hyperlinked names. -
def
toString(): String
- Definition Classes
- AnyRef → Any
- def typeToHtml(tpe: TypeEntity, hasLinks: Boolean): NodeSeq
- def typeToHtml(tpes: List[TypeEntity], hasLinks: Boolean): NodeSeq
- def typesToHtml(tpess: List[TypeEntity], hasLinks: Boolean, sep: NodeSeq): NodeSeq
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) ⇒ Unit): Unit
- Definition Classes
- Page
-
def
writeFor(site: HtmlFactory): Unit
Writes this page as a file.
- def →[B](y: B): (HtmlPage, B)
- object Image extends Enumeration
Deprecated Value Members
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from HtmlPage to StringFormat[HtmlPage] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
The Scala compiler and reflection APIs.