Scala Compiler2.13.17 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package doc
  Definition Classes
    nsc
-  package html
  Definition Classes
    doc
-  package page
  Definition Classes
    html
-  package diagram
  Definition Classes
    page
- EntityPage
- IndexScript

t

scala.tools.nsc.doc.html.page

# EntityPage

###
Companion object EntityPage

#### trait EntityPage extends HtmlPage

Source
  Entity.scala

Linear Supertypes
HtmlPage, Page, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. EntityPage
2. HtmlPage
3. Page
4. AnyRef
5. 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

### Abstract Value Members

1.  abstract def docletReporter: Reporter

   ScalaDoc reporter for error handling

   ScalaDoc reporter for error handling

   Definition Classes
     EntityPage → HtmlPage
2.  abstract def generator: DiagramGenerator
3.  abstract def tpl: DocTemplateEntity
4.  abstract def universe: Universe

### Concrete Value Members

1.  object Image extends Enumeration
   Definition Classes
     HtmlPage
2.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
3.  final def ##: Int
   Definition Classes
     AnyRef → Any
4.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from EntityPage toany2stringadd[EntityPage] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
5.  def ->[B](y: B): (EntityPage, B)
   Implicit
     This member is added by an implicit conversion from EntityPage toArrowAssoc[EntityPage] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
6.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
7.  val absValueMembers: collection.immutable.List[MemberEntity]
8.  def absoluteLinkTo(path: List[String]): String
   Definition Classes
     Page
9.  val allTypeMembers: collection.immutable.List[TemplateEntity with MemberEntity]
10.  final def asInstanceOf[T0]: T0
    Definition Classes
      Any
11.  def blockToHtml(block: Block): Elems
    Definition Classes
      HtmlPage
12.  def body: Elems

    The body of this page.

    The body of this page.

    Definition Classes
      EntityPage → HtmlPage
13.  def bodyToHtml(body: Body): Elems
    Definition Classes
      HtmlPage
14.  def boundsToHtml(hi: Option[TypeEntity], lo: Option[TypeEntity], hasLinks: Boolean): Elems
15.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
16.  def commentToHtml(comment: Comment): Elems

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

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

    Definition Classes
      HtmlPage
17.  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.

    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.

    Definition Classes
      HtmlPage
18.  def companionAndPackage(tpl: DocTemplateEntity): Elems
    Definition Classes
      HtmlPage
19.  val concValueMembers: collection.immutable.List[MemberEntity]
20.  val constructors: collection.immutable.List[MemberEntity]
21.  val content: Body
22.  def createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream
    Definition Classes
      Page
23.  val deprTypeMembers: collection.immutable.List[TemplateEntity with MemberEntity]
24.  val deprValueMembers: collection.immutable.List[MemberEntity]
25.  def description: String

    The page description

    The page description

    Attributes
      protected
    Definition Classes
      HtmlPage
26.  def docEntityImageClass(tpl: DocTemplateEntity): String
    Definition Classes
      HtmlPage
27.  def docEntityKindToCompanionTitle(ety: DocTemplateEntity, baseString: String = "See companion"): String
    Definition Classes
      HtmlPage
28.  def ensuring(cond: (EntityPage) => Boolean, msg: => Any): EntityPage
    Implicit
      This member is added by an implicit conversion from EntityPage toEnsuring[EntityPage] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
29.  def ensuring(cond: (EntityPage) => Boolean): EntityPage
    Implicit
      This member is added by an implicit conversion from EntityPage toEnsuring[EntityPage] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
30.  def ensuring(cond: Boolean, msg: => Any): EntityPage
    Implicit
      This member is added by an implicit conversion from EntityPage toEnsuring[EntityPage] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
31.  def ensuring(cond: Boolean): EntityPage
    Implicit
      This member is added by an implicit conversion from EntityPage toEnsuring[EntityPage] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
32.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
33.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
34.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
35.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
36.  def hasCompanion(mbr: TemplateEntity): Boolean
    Definition Classes
      Page
37.  def hasPage(e: DocTemplateEntity): Boolean
    Definition Classes
      HtmlPage
38.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
39.  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.

    Definition Classes
      EntityPage → HtmlPage
40.  def inlineToHtml(inl: Inline): Elems
    Definition Classes
      HtmlPage
41.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
42.  def keywords: String

    The page keywords

    The page keywords

    Attributes
      protected
    Definition Classes
      HtmlPage
43.  def kindToString(mbr: MemberEntity): String
    Definition Classes
      Page
44.  def linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean): Elems
    Definition Classes
      HtmlPage
45.  def listItemsToHtml(items: collection.Seq[Block]): Elems
    Definition Classes
      HtmlPage
46.  def memberToCommentBodyHtml(mbr: MemberEntity, inTpl: DocTemplateEntity, isSelf: Boolean, isReduced: Boolean = false): Elems
47.  def memberToCommentHtml(mbr: MemberEntity, inTpl: DocTemplateEntity, isSelf: Boolean): Elems
48.  def memberToHtml(mbr: MemberEntity, inTpl: DocTemplateEntity, isParent: Boolean = false, indentation: Int = 0): Elems
49.  def memberToShortCommentHtml(mbr: MemberEntity, isSelf: Boolean): Elems
50.  def memberToShortCommentTitleTag(mbr: MemberEntity): String
51.  def memberToUseCaseCommentHtml(mbr: MemberEntity, isSelf: Boolean): Elems
52.  def memsDiv(cls: String, header: String, mems: List[MemberEntity], name: String = null): Elems
53.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
54.  val nonAbsValueMembers: collection.immutable.List[MemberEntity]
55.  val nonDeprValueMembers: collection.immutable.List[MemberEntity]
56.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
57.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
58.  val packageMembers: collection.immutable.List[TemplateEntity with MemberEntity]
59.  val 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
      EntityPage → Page
60.  def permalink(template: Entity, isSelf: Boolean = true): Elem
    Definition Classes
      HtmlPage
61.  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
62.  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
63.  def search: Div
64.  val shadowedImplicitMembers: collection.immutable.List[MemberEntity]
65.  def signature(mbr: MemberEntity, isSelf: Boolean, isReduced: Boolean = false): Elems

    name, tparams, params, result

66.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
67.  def templateToHtml(tpl: TemplateEntity, name: String = null): Elem

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

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

    Definition Classes
      HtmlPage
68.  def templateToPath(tpl: TemplateEntity): List[String]
    Definition Classes
      Page
69.  def templatesToHtml(tplss: List[TemplateEntity], sep: Elems): Elems

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

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

    Definition Classes
      HtmlPage
70.  def title: String

    The title of this page.

    The title of this page.

    Definition Classes
      EntityPage → HtmlPage
71.  def toString(): String
    Definition Classes
      AnyRef → Any
72.  def treeToHtml(tree: TreeEntity): Elems

73.  val typeMembers: collection.immutable.List[TemplateEntity with MemberEntity]
74.  def typeToHtml(tpe: TypeEntity, hasLinks: Boolean): Elems
    Definition Classes
      HtmlPage
75.  def typeToHtml(tpes: List[TypeEntity], hasLinks: Boolean): Elems
    Definition Classes
      HtmlPage
76.  def typesToHtml(tpess: List[TypeEntity], hasLinks: Boolean, sep: Elems): Elems
    Definition Classes
      HtmlPage
77.  val valueMembers: collection.immutable.List[MemberEntity]
78.  def visibility(mbr: MemberEntity): Option[Elems]
79.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
80.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
81.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
82.  def writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) => Unit): Unit
    Definition Classes
      Page
83.  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
84.  def writeHtml(encoding: String)(w: Writer): Unit
    Definition Classes
      HtmlPage

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from EntityPage toStringFormat[EntityPage] 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): (EntityPage, B)
   Implicit
     This member is added by an implicit conversion from EntityPage toArrowAssoc[EntityPage] 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 HtmlPage

### Inherited from Page

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromEntityPage to any2stringadd[EntityPage]

### Inherited by implicit conversion StringFormat fromEntityPage to StringFormat[EntityPage]

### Inherited by implicit conversion Ensuring fromEntityPage to Ensuring[EntityPage]

### Inherited by implicit conversion ArrowAssoc fromEntityPage to ArrowAssoc[EntityPage]

### Ungrouped