scala.tools.nsc.doc.html.page

Template

class Template extends HtmlPage

Source
Template.scala
Linear Supertypes
HtmlPage, Page, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Template
  2. HtmlPage
  3. Page
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringfmt
  2. by any2stringadd
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Template(universe: Universe, tpl: DocTemplateEntity)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Template to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Template, B)

    Implicit information
    This member is added by an implicit conversion from Template to ArrowAssoc[Template] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. val absValueMembers: List[MemberEntity]

  9. def absoluteLinkTo(path: List[String]): String

    Definition Classes
    Page

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def blockToHtml(block: Block): NodeSeq

    Definition Classes
    HtmlPage

  12. val body: Elem

    The body of this page.

    The body of this page.

    Definition Classes
    Template → HtmlPage

  13. def bodyToHtml(body: Body): NodeSeq

    Definition Classes
    HtmlPage

  14. def boundsToHtml(hi: Option[TypeEntity], lo: Option[TypeEntity], hasLinks: Boolean): NodeSeq

  15. def boundsToString(hi: Option[TypeEntity], lo: Option[TypeEntity]): String

  16. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

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

  19. val concValueMembers: List[MemberEntity]

  20. val constructors: List[MemberEntity]

  21. def createFileOutputStream(site: HtmlFactory): FileOutputStream

    Definition Classes
    Page

  22. def defParamsToString(d: MemberEntity with Def): String

  23. val deprValueMembers: List[MemberEntity]

  24. def description: String

    The page description

    The page description

    Attributes
    protected
    Definition Classes
    HtmlPage

  25. def docEntityKindToBigImage(ety: DocTemplateEntity): String

    Returns the _big image name corresponding to the DocTemplate Entity (upper left icon)

    Returns the _big image name corresponding to the DocTemplate Entity (upper left icon)

    Definition Classes
    HtmlPage

  26. def docEntityKindToString(ety: DocTemplateEntity): String

    Definition Classes
    Page

  27. def ensuring(cond: (Template) ⇒ Boolean, msg: ⇒ Any): Template

    Implicit information
    This member is added by an implicit conversion from Template to Ensuring[Template] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  28. def ensuring(cond: (Template) ⇒ Boolean): Template

    Implicit information
    This member is added by an implicit conversion from Template to Ensuring[Template] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  29. def ensuring(cond: Boolean, msg: ⇒ Any): Template

    Implicit information
    This member is added by an implicit conversion from Template to Ensuring[Template] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  30. def ensuring(cond: Boolean): Template

    Implicit information
    This member is added by an implicit conversion from Template to Ensuring[Template] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  31. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  32. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  33. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  34. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Template to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  35. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  36. def hasPage(e: DocTemplateEntity): Boolean

    Definition Classes
    HtmlPage

  37. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  38. val headers: Group

    Additional header elements (links, scripts, meta tags, etc.

    Additional header elements (links, scripts, meta tags, etc.) required for this page.

    Definition Classes
    Template → HtmlPage

  39. def inlineToHtml(inl: Inline): NodeSeq

    Definition Classes
    HtmlPage

  40. def isExcluded(dtpl: DocTemplateEntity): Boolean

    Definition Classes
    Page

  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

  44. def listItemsToHtml(items: Seq[Block]): NodeSeq

    Definition Classes
    HtmlPage

  45. def memberToCommentBodyHtml(mbr: MemberEntity, isSelf: Boolean, isReduced: Boolean = false): NodeSeq

  46. def memberToCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq

  47. def memberToHtml(mbr: MemberEntity): NodeSeq

  48. def memberToInlineCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq

  49. def memberToShortCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq

  50. def memberToUseCaseCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq

  51. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  52. val nonAbsValueMembers: List[MemberEntity]

  53. final def notify(): Unit

    Definition Classes
    AnyRef

  54. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  55. 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
    Template → Page

  56. def relativeLinkTo(destPath: List[String]): String

    A relative link from this page to some destination path.

    A relative link from this page to some destination path.

    destPath

    The path that the link will point to.

    Definition Classes
    Page

  57. def relativeLinkTo(destPage: HtmlPage): String

    A relative link from this page to some destination page in the Scaladoc site.

    A relative link from this page to some destination page in the Scaladoc site.

    destPage

    The page that the link will point to.

    Definition Classes
    Page

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

    Definition Classes
    Page

  59. val self: Any

    Implicit information
    This member is added by an implicit conversion from Template to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat

  60. val self: Any

    Implicit information
    This member is added by an implicit conversion from Template to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  61. def signature(mbr: MemberEntity, isSelf: Boolean, isReduced: Boolean = false): NodeSeq

    name, tparams, params, result

  62. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  63. def templateToHtml(tpl: TemplateEntity, name: String = null): Node with Serializable

    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

  64. def templateToPath(tpl: TemplateEntity): List[String]

    Definition Classes
    Page

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

  66. def title: String

    The title of this page.

    The title of this page.

    Definition Classes
    Template → HtmlPage

  67. def toString(): String

    Definition Classes
    AnyRef → Any

  68. def tparamsToString(tpss: List[TypeParam]): String

  69. def treeToHtml(tree: TreeEntity): NodeSeq

  70. val typeMembers: List[MemberEntity]

  71. def typeToHtml(tpe: TypeEntity, hasLinks: Boolean): NodeSeq

    Definition Classes
    HtmlPage

  72. def typesToHtml(tpess: List[TypeEntity], hasLinks: Boolean, sep: NodeSeq): NodeSeq

    Definition Classes
    HtmlPage

  73. val valueMembers: List[MemberEntity]

  74. def visibility(mbr: MemberEntity): Option[Paragraph]

  75. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  76. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  77. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    HtmlPage → Page

  79. def →[B](y: B): (Template, B)

    Implicit information
    This member is added by an implicit conversion from Template to ArrowAssoc[Template] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def x: Template

    Implicit information
    This member is added by an implicit conversion from Template to ArrowAssoc[Template] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Template

    Implicit information
    This member is added by an implicit conversion from Template to Ensuring[Template] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from HtmlPage

Inherited from Page

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringfmt from Template to StringFormat

Inherited by implicit conversion any2stringadd from Template to StringAdd

Inherited by implicit conversion any2ArrowAssoc from Template to ArrowAssoc[Template]

Inherited by implicit conversion any2Ensuring from Template to Ensuring[Template]