Packages

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. val absValueMembers: collection.immutable.List[MemberEntity]
  3. def absoluteLinkTo(path: List[String]): String
    Definition Classes
    Page
  4. def blockToHtml(block: Block): NodeSeq
    Definition Classes
    HtmlPage
  5. def body: Elem

    The body of this page.

    The body of this page.

    Definition Classes
    EntityPage → HtmlPage
  6. def bodyToHtml(body: Body): NodeSeq
    Definition Classes
    HtmlPage
  7. def boundsToHtml(hi: Option[TypeEntity], lo: Option[TypeEntity], hasLinks: Boolean): NodeSeq
  8. 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
  9. 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
  10. def companionAndPackage(tpl: DocTemplateEntity): NodeSeq
    Definition Classes
    HtmlPage
  11. val concValueMembers: collection.immutable.List[MemberEntity]
  12. val constructors: collection.immutable.List[MemberEntity]
  13. val content: Elem
  14. def createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream
    Definition Classes
    Page
  15. val deprValueMembers: collection.immutable.List[MemberEntity]
  16. def docEntityImageClass(tpl: DocTemplateEntity): String
    Definition Classes
    HtmlPage
  17. def docEntityKindToCompanionTitle(ety: DocTemplateEntity, baseString: String = "See companion"): String
    Definition Classes
    HtmlPage
  18. def hasCompanion(mbr: TemplateEntity): Boolean
    Definition Classes
    Page
  19. def hasPage(e: DocTemplateEntity): Boolean
    Definition Classes
    HtmlPage
  20. 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
  21. def inlineToHtml(inl: Inline): NodeSeq
    Definition Classes
    HtmlPage
  22. def kindToString(mbr: MemberEntity): String
    Definition Classes
    Page
  23. def linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean): NodeSeq
    Definition Classes
    HtmlPage
  24. def listItemsToHtml(items: collection.Seq[Block]): NodeSeq
    Definition Classes
    HtmlPage
  25. def memberToCommentBodyHtml(mbr: MemberEntity, inTpl: DocTemplateEntity, isSelf: Boolean, isReduced: Boolean = false): NodeSeq
  26. def memberToCommentHtml(mbr: MemberEntity, inTpl: DocTemplateEntity, isSelf: Boolean): NodeSeq
  27. def memberToHtml(mbr: MemberEntity, inTpl: DocTemplateEntity, isParent: Boolean = false, indentation: Int = 0): NodeSeq
  28. def memberToInlineCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq
  29. def memberToShortCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq
  30. def memberToShortCommentTitleTag(mbr: MemberEntity): String
  31. def memberToUseCaseCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq
  32. val nonAbsValueMembers: collection.immutable.List[MemberEntity]
  33. val nonDeprValueMembers: collection.immutable.List[MemberEntity]
  34. 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
  35. def permalink(template: Entity, isSelf: Boolean = true): Elem
    Definition Classes
    HtmlPage
  36. 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
  37. 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
  38. def search: Elem
  39. val shadowedImplicitMembers: collection.immutable.List[MemberEntity]
  40. def signature(mbr: MemberEntity, isSelf: Boolean, isReduced: Boolean = false): NodeSeq

    name, tparams, params, result

  41. 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
  42. def templateToPath(tpl: TemplateEntity): List[String]
    Definition Classes
    Page
  43. 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
  44. def title: String

    The title of this page.

    The title of this page.

    Definition Classes
    EntityPage → HtmlPage
  45. def treeToHtml(tree: TreeEntity): NodeSeq

  46. val typeMembers: collection.immutable.List[TemplateEntity with MemberEntity]
  47. def typeToHtml(tpe: TypeEntity, hasLinks: Boolean): NodeSeq
    Definition Classes
    HtmlPage
  48. def typeToHtml(tpes: List[TypeEntity], hasLinks: Boolean): NodeSeq
    Definition Classes
    HtmlPage
  49. def typesToHtml(tpess: List[TypeEntity], hasLinks: Boolean, sep: NodeSeq): NodeSeq
    Definition Classes
    HtmlPage
  50. val valueMembers: collection.immutable.List[MemberEntity]
  51. def visibility(mbr: MemberEntity): Option[Paragraph]
  52. def writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) ⇒ Unit): Unit
    Definition Classes
    Page
  53. 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