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
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. All

Instance Constructors

  1. new HtmlPage()

Abstract Value Members

  1. abstract def body: NodeSeq

    The body of this page.

  2. 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

Concrete Value Members

  1. def absoluteLinkTo(path: List[String]): String
    Definition Classes
    Page
  2. def blockToHtml(block: Block): NodeSeq
  3. def bodyToHtml(body: Body): NodeSeq
  4. def commentToHtml(comment: Comment): NodeSeq

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

  5. 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.

  6. def companionAndPackage(tpl: DocTemplateEntity): NodeSeq
  7. def createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream
    Definition Classes
    Page
  8. def docEntityImageClass(tpl: DocTemplateEntity): String
  9. def docEntityKindToCompanionTitle(ety: DocTemplateEntity, baseString: String = "See companion"): String
  10. def hasCompanion(mbr: TemplateEntity): Boolean
    Definition Classes
    Page
  11. def hasPage(e: DocTemplateEntity): Boolean
  12. def inlineToHtml(inl: Inline): NodeSeq
  13. def kindToString(mbr: MemberEntity): String
    Definition Classes
    Page
  14. def linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean): NodeSeq
  15. def listItemsToHtml(items: collection.Seq[Block]): NodeSeq
  16. def permalink(template: Entity): Elem
  17. 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
  18. 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
  19. def templateToHtml(tpl: TemplateEntity, name: String = null): Node with Serializable

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

  20. def templateToPath(tpl: TemplateEntity): List[String]
    Definition Classes
    Page
  21. def templatesToHtml(tplss: List[TemplateEntity], sep: NodeSeq): NodeSeq

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

  22. def typeToHtml(tpe: TypeEntity, hasLinks: Boolean): NodeSeq
  23. def typeToHtml(tpes: List[TypeEntity], hasLinks: Boolean): NodeSeq
  24. def typesToHtml(tpess: List[TypeEntity], hasLinks: Boolean, sep: NodeSeq): NodeSeq
  25. def writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) ⇒ Unit): Unit
    Definition Classes
    Page
  26. 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
  27. object Image extends Enumeration