Scala Compiler2.12.21 < 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
 
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. All

### 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 to any2stringadd[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 to ArrowAssoc[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.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
10.  def blockToHtml(block: Block): NodeSeq
    Definition Classes
      HtmlPage
11.  def body: Elem

    The body of this page.

    The body of this page.

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

    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
16.  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.

    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
17.  def companionAndPackage(tpl: DocTemplateEntity): NodeSeq
    Definition Classes
      HtmlPage
18.  val concValueMembers: collection.immutable.List[MemberEntity]
19.  val constructors: collection.immutable.List[MemberEntity]
20.  val content: Elem
21.  def createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream
    Definition Classes
      Page
22.  val deprValueMembers: collection.immutable.List[MemberEntity]
23.  def description: String

    The page description

    The page description

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

    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
38.  def inlineToHtml(inl: Inline): NodeSeq
    Definition Classes
      HtmlPage
39.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
40.  def keywords: String

    The page keywords

    The page keywords

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

    name, tparams, params, result

63.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
64.  def templateToHtml(tpl: TemplateEntity, name: String = null): Node

    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
65.  def templateToPath(tpl: TemplateEntity): List[String]
    Definition Classes
      Page
66.  def templatesToHtml(tplss: List[TemplateEntity], sep: NodeSeq): NodeSeq

    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
67.  def title: String

    The title of this page.

    The title of this page.

    Definition Classes
      EntityPage → HtmlPage
68.  def toString(): String
    Definition Classes
      AnyRef → Any
69.  def treeToHtml(tree: TreeEntity): NodeSeq

70.  val typeMembers: collection.immutable.List[TemplateEntity with MemberEntity]
71.  def typeToHtml(tpe: TypeEntity, hasLinks: Boolean): NodeSeq
    Definition Classes
      HtmlPage
72.  def typeToHtml(tpes: List[TypeEntity], hasLinks: Boolean): NodeSeq
    Definition Classes
      HtmlPage
73.  def typesToHtml(tpess: List[TypeEntity], hasLinks: Boolean, sep: NodeSeq): NodeSeq
    Definition Classes
      HtmlPage
74.  val valueMembers: collection.immutable.List[MemberEntity]
75.  def visibility(mbr: MemberEntity): Option[NodeSeq]
76.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
77.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
78.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... ) @native()
79.  def writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) ⇒ Unit): Unit
    Definition Classes
      Page
80.  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
81.  def →[B](y: B): (EntityPage, B)
    Implicit
      This member is added by an implicit conversion from EntityPage to ArrowAssoc[EntityPage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from EntityPage to StringFormat[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.

### Inherited from HtmlPage

### Inherited from Page

### Inherited from AnyRef

### Inherited from Any

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

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

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

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

### Ungrouped