Template

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. final def ==(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

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

   Definition Classes

   Any

6. val absValueMembers: List[MemberEntity]

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

   Definition Classes

   Page

8. final def asInstanceOf[T0]: T0

   Definition Classes

   Any

9. def blockToHtml(block: Block): NodeSeq

   Definition Classes

   HtmlPage

10. def body: Elem

    The body of this page.

    The body of this page.

    Definition Classes

    Template → HtmlPage

11. def bodyToHtml(body: Body): NodeSeq

    Definition Classes

    HtmlPage

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

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

14. def clone(): AnyRef

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws()

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. val concValueMembers: List[MemberEntity]

18. val constructors: List[MemberEntity]

19. def createFileOutputStream(site: HtmlFactory): FileOutputStream

    Definition Classes

    Page

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

21. val deprValueMembers: List[MemberEntity]

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

23. def docEntityKindToString(ety: DocTemplateEntity): String

    Definition Classes

    Page

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

    Definition Classes

    AnyRef

25. def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

26. def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws()

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

    Definition Classes

    AnyRef → Any

28. def hasPage(e: DocTemplateEntity): Boolean

    Definition Classes

    HtmlPage

29. def hashCode(): Int

    Definition Classes

    AnyRef → Any

30. def 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

31. def inlineToHtml(inl: Inline): NodeSeq

    Definition Classes

    HtmlPage

32. def isExcluded(dtpl: DocTemplateEntity): Boolean

    Definition Classes

    Page

33. final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

34. def kindToString(mbr: MemberEntity): String

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

    Definition Classes

    HtmlPage

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

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

38. def memberToFullCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq

39. def memberToHtml(mbr: MemberEntity): NodeSeq

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

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

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

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

    Definition Classes

    AnyRef

44. val nonAbsValueMembers: List[MemberEntity]

45. final def notify(): Unit

    Definition Classes

    AnyRef

46. final def notifyAll(): Unit

    Definition Classes

    AnyRef

47. def 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

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

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

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

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

    name, tparams, params, result

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

    Definition Classes

    AnyRef

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

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

    Definition Classes

    Page

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

56. def title: String

    The title of this page.

    The title of this page.

    Definition Classes

    Template → HtmlPage

57. def toString(): String

    Definition Classes

    AnyRef → Any

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

59. def treeToHtml(tree: TreeEntity): NodeSeq

60. val typeMembers: List[MemberEntity]

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

    Definition Classes

    HtmlPage

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

    Definition Classes

    HtmlPage

63. val valueMembers: List[MemberEntity]

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

65. final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws()

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

    Definition Classes

    AnyRef

    Annotations

    @throws()

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

    Definition Classes

    AnyRef

    Annotations

    @throws()

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