trait EntityPage extends HtmlPage
- Alphabetic
- By Inheritance
- EntityPage
- HtmlPage
- Page
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
docletReporter: Reporter
ScalaDoc reporter for error handling
ScalaDoc reporter for error handling
- Definition Classes
- EntityPage → HtmlPage
- abstract def generator: DiagramGenerator
- abstract def tpl: DocTemplateEntity
- abstract def universe: Universe
Concrete Value Members
-
object
Image
extends Enumeration
- Definition Classes
- HtmlPage
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val absValueMembers: collection.immutable.List[MemberEntity]
-
def
absoluteLinkTo(path: List[String]): String
- Definition Classes
- Page
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
blockToHtml(block: Block): NodeSeq
- Definition Classes
- HtmlPage
-
def
body: Elem
The body of this page.
The body of this page.
- Definition Classes
- EntityPage → HtmlPage
-
def
bodyToHtml(body: Body): NodeSeq
- Definition Classes
- HtmlPage
- def boundsToHtml(hi: Option[TypeEntity], lo: Option[TypeEntity], hasLinks: Boolean): NodeSeq
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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
-
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
-
def
companionAndPackage(tpl: DocTemplateEntity): NodeSeq
- Definition Classes
- HtmlPage
- val concValueMembers: collection.immutable.List[MemberEntity]
- val constructors: collection.immutable.List[MemberEntity]
- val content: Elem
-
def
createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream
- Definition Classes
- Page
- val deprValueMembers: collection.immutable.List[MemberEntity]
-
def
description: String
The page description
The page description
- Attributes
- protected
- Definition Classes
- HtmlPage
-
def
docEntityImageClass(tpl: DocTemplateEntity): String
- Definition Classes
- HtmlPage
-
def
docEntityKindToCompanionTitle(ety: DocTemplateEntity, baseString: String = "See companion"): String
- Definition Classes
- HtmlPage
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasCompanion(mbr: TemplateEntity): Boolean
- Definition Classes
- Page
-
def
hasPage(e: DocTemplateEntity): Boolean
- Definition Classes
- HtmlPage
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
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
-
def
inlineToHtml(inl: Inline): NodeSeq
- Definition Classes
- HtmlPage
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
keywords: String
The page keywords
The page keywords
- Attributes
- protected
- Definition Classes
- HtmlPage
-
def
kindToString(mbr: MemberEntity): String
- Definition Classes
- Page
-
def
linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean): NodeSeq
- Definition Classes
- HtmlPage
-
def
listItemsToHtml(items: collection.Seq[Block]): NodeSeq
- Definition Classes
- HtmlPage
- def memberToCommentBodyHtml(mbr: MemberEntity, inTpl: DocTemplateEntity, isSelf: Boolean, isReduced: Boolean = false): NodeSeq
- def memberToCommentHtml(mbr: MemberEntity, inTpl: DocTemplateEntity, isSelf: Boolean): NodeSeq
- def memberToHtml(mbr: MemberEntity, inTpl: DocTemplateEntity, isParent: Boolean = false, indentation: Int = 0): NodeSeq
- def memberToInlineCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq
- def memberToShortCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq
- def memberToUseCaseCommentHtml(mbr: MemberEntity, isSelf: Boolean): NodeSeq
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val nonAbsValueMembers: collection.immutable.List[MemberEntity]
- val nonDeprValueMembers: collection.immutable.List[MemberEntity]
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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 thatpath
has a length of at least one.- Definition Classes
- EntityPage → Page
-
def
permalink(template: Entity, isSelf: Boolean = true): Elem
- Definition Classes
- HtmlPage
-
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
-
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
- def search: Elem
- val shadowedImplicitMembers: collection.immutable.List[MemberEntity]
-
def
signature(mbr: MemberEntity, isSelf: Boolean, isReduced: Boolean = false): NodeSeq
name, tparams, params, result
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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
-
def
templateToPath(tpl: TemplateEntity): List[String]
- Definition Classes
- Page
-
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
-
def
title: String
The title of this page.
The title of this page.
- Definition Classes
- EntityPage → HtmlPage
-
def
toString(): String
- Definition Classes
- AnyRef → Any
- def treeToHtml(tree: TreeEntity): NodeSeq
- val typeMembers: collection.immutable.List[TemplateEntity with MemberEntity]
-
def
typeToHtml(tpe: TypeEntity, hasLinks: Boolean): NodeSeq
- Definition Classes
- HtmlPage
-
def
typeToHtml(tpes: List[TypeEntity], hasLinks: Boolean): NodeSeq
- Definition Classes
- HtmlPage
-
def
typesToHtml(tpess: List[TypeEntity], hasLinks: Boolean, sep: NodeSeq): NodeSeq
- Definition Classes
- HtmlPage
- val valueMembers: collection.immutable.List[MemberEntity]
- def visibility(mbr: MemberEntity): Option[Paragraph]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) ⇒ Unit): Unit
- Definition Classes
- Page
-
def
writeFor(site: HtmlFactory): Unit
Writes this page as a file.
-
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
The Scala compiler and reflection APIs.