Packages

abstract class HtmlPage extends Page

An html page that is part of a Scaladoc site.

Self Type
HtmlPage
Source
HtmlPage.scala
Linear Supertypes
Page, AnyRef, Any
Known Subclasses
EntityPage
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HtmlPage
  2. Page
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HtmlPage()

Abstract Value Members

  1. abstract def body: Elems

    The body of this page.

  2. abstract def docletReporter: Reporter

    ScalaDoc reporter for error handling

    ScalaDoc reporter for error handling

    Attributes
    protected
  3. abstract def headers: Elems

    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
  4. 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.tail is a list of folder names leading to this page (from closest package to one-above-root package), path.head is the file name of this page. Note that path has a length of at least one.

    Definition Classes
    Page
  5. abstract def title: String

    The title of this page.

    The title of this page.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from HtmlPage toany2stringadd[HtmlPage] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HtmlPage, B)
    Implicit
    This member is added by an implicit conversion from HtmlPage toArrowAssoc[HtmlPage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def absoluteLinkTo(path: List[String]): String
    Definition Classes
    Page
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def blockToHtml(block: Block): Elems
  9. def bodyToHtml(body: Body): Elems
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def commentToHtml(comment: Comment): Elems

    Transforms a comment into an styled HTML tree representing its body.

  12. def commentToHtml(comment: Option[Comment]): Elems

    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.

  13. def companionAndPackage(tpl: DocTemplateEntity): Elems
  14. def createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream
    Definition Classes
    Page
  15. def description: String

    The page description

    The page description

    Attributes
    protected
  16. def docEntityImageClass(tpl: DocTemplateEntity): String
  17. def docEntityKindToCompanionTitle(ety: DocTemplateEntity, baseString: String = "See companion"): String
  18. def ensuring(cond: (HtmlPage) => Boolean, msg: => Any): HtmlPage
    Implicit
    This member is added by an implicit conversion from HtmlPage toEnsuring[HtmlPage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: (HtmlPage) => Boolean): HtmlPage
    Implicit
    This member is added by an implicit conversion from HtmlPage toEnsuring[HtmlPage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean, msg: => Any): HtmlPage
    Implicit
    This member is added by an implicit conversion from HtmlPage toEnsuring[HtmlPage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean): HtmlPage
    Implicit
    This member is added by an implicit conversion from HtmlPage toEnsuring[HtmlPage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  24. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def hasCompanion(mbr: TemplateEntity): Boolean
    Definition Classes
    Page
  27. def hasPage(e: DocTemplateEntity): Boolean
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def inlineToHtml(inl: Inline): Elems
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def keywords: String

    The page keywords

    The page keywords

    Attributes
    protected
  32. def kindToString(mbr: MemberEntity): String
    Definition Classes
    Page
  33. def linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean): Elems
  34. def listItemsToHtml(items: collection.Seq[Block]): Elems
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. def permalink(template: Entity, isSelf: Boolean = true): Elem
  39. 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
  40. 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
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def templateToHtml(tpl: TemplateEntity, name: String = null): Elem

    Returns the HTML code that represents the template in tpl as a hyperlinked name.

  43. def templateToPath(tpl: TemplateEntity): List[String]
    Definition Classes
    Page
  44. def templatesToHtml(tplss: List[TemplateEntity], sep: Elems): Elems

    Returns the HTML code that represents the templates in tpls as a list of hyperlinked names.

  45. def toString(): String
    Definition Classes
    AnyRef → Any
  46. def typeToHtml(tpe: TypeEntity, hasLinks: Boolean): Elems
  47. def typeToHtml(tpes: List[TypeEntity], hasLinks: Boolean): Elems
  48. def typesToHtml(tpess: List[TypeEntity], hasLinks: Boolean, sep: Elems): Elems
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  52. def writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) => Unit): Unit
    Definition Classes
    Page
  53. def writeFor(site: HtmlFactory): Unit

    Writes this page as a file.

    Writes this page as a file. The file's location is relative to the generator's site root, and the encoding is also defined by the generator.

    site

    The generator that is writing this page.

    Definition Classes
    HtmlPage → Page
  54. def writeHtml(encoding: String)(w: Writer): Unit
  55. object Image extends Enumeration

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HtmlPage toStringFormat[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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (HtmlPage, B)
    Implicit
    This member is added by an implicit conversion from HtmlPage toArrowAssoc[HtmlPage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Page

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHtmlPage to any2stringadd[HtmlPage]

Inherited by implicit conversion StringFormat fromHtmlPage to StringFormat[HtmlPage]

Inherited by implicit conversion Ensuring fromHtmlPage to Ensuring[HtmlPage]

Inherited by implicit conversion ArrowAssoc fromHtmlPage to ArrowAssoc[HtmlPage]

Ungrouped