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. Hide All
  2. Show all
  1. Template
  2. HtmlPage
  3. Page
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Template (tpl: DocTemplateEntity)

Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef

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

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. val absValueMembers : List[MemberEntity]

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

    Definition Classes
    Page

  8. def argumentToHtml (arg: ValueArgument): NodeSeq

  9. def argumentsToHtml (argss: List[ValueArgument]): NodeSeq

  10. def asInstanceOf [T0] : T0

    Attributes
    final
    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 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

  25. def docEntityKindToString (ety: DocTemplateEntity): String

    Definition Classes
    Page

  26. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  27. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  28. def finalize (): Unit

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

  29. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  30. def hasPage (e: DocTemplateEntity): Boolean

    Definition Classes
    HtmlPage

  31. def hashCode (): Int

    Definition Classes
    AnyRef → Any

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

  33. def inlineToHtml (inl: Inline): NodeSeq

    Definition Classes
    HtmlPage

  34. def isExcluded (dtpl: DocTemplateEntity): Boolean

    Definition Classes
    Page

  35. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  36. def kindToString (mbr: MemberEntity): String

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

    Definition Classes
    HtmlPage

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

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

  40. def memberToHtml (mbr: MemberEntity): NodeSeq

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

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

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

  44. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  45. val nonAbsValueMembers : List[MemberEntity]

  46. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  47. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

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

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

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

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

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

    name, tparams, params, result

  53. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  54. def templateToHtml (tpl: TemplateEntity): 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

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

    Definition Classes
    Page

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

  57. val title : String

    The title of this page.

    The title of this page.

    Definition Classes
    Template → HtmlPage

  58. def toString (): String

    Definition Classes
    AnyRef → Any

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

  60. def treeToHtml (tree: TreeEntity): NodeSeq

  61. val typeMembers : List[MemberEntity]

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

    Definition Classes
    HtmlPage

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

    Definition Classes
    HtmlPage

  64. val valueMembers : List[MemberEntity]

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

  66. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  68. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

Inherited from HtmlPage

Inherited from Page

Inherited from AnyRef

Inherited from Any