Index

Instance Constructors

new Index(universe: Universe, index: doc.Index)

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Index to StringAdd performed by method any2stringadd in scala.Predef.
Definition Classes
StringAdd
def ->[B](y: B): (Index, B)

Implicit information
This member is added by an implicit conversion from Index to ArrowAssoc[Index] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
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
val body: Elem

The body of this page.
The body of this page.

Definition Classes
Index → HtmlPage
def bodyToHtml(body: Body): NodeSeq

Definition Classes
HtmlPage
def browser: Elem
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 createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream

Definition Classes
Page
def description: String

The page description
The page description

Attributes
protected
Definition Classes
HtmlPage
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
def ensuring(cond: (Index) ⇒ Boolean, msg: ⇒ Any): Index

Implicit information
This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Index) ⇒ Boolean): Index

Implicit information
This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Index

Implicit information
This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Index

Implicit information
This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring 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 information
This member is added by an implicit conversion from Index to StringFormat performed by method any2stringfmt in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasPage(e: DocTemplateEntity): Boolean

Definition Classes
HtmlPage
def hashCode(): Int

Definition Classes
AnyRef → Any
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
Index → HtmlPage
val index: doc.Index
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 letters: NodeSeq
def linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean): NodeSeq

Definition Classes
HtmlPage
def listItemsToHtml(items: collection.Seq[Block]): NodeSeq

Definition Classes
HtmlPage
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def packageQualifiedName(ety: DocTemplateEntity): String
def path: collection.immutable.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
Index → Page
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(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
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
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
Index → HtmlPage
def toString(): String

Definition Classes
AnyRef → Any
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
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.
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
def →[B](y: B): (Index, B)

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

Shadowed Implicit Value Members

val self: Any
Implicit information
This member is added by an implicit conversion from Index to StringAdd performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(index: StringAdd).self
Definition Classes
StringAdd
val self: Any
Implicit information
This member is added by an implicit conversion from Index to StringFormat performed by method any2stringfmt in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(index: StringFormat).self
Definition Classes
StringFormat

Deprecated Value Members

def x: Index
Implicit information
This member is added by an implicit conversion from Index to ArrowAssoc[Index] performed by method any2ArrowAssoc in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(index: ArrowAssoc[Index]).x
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use leftOfArrow instead
def x: Index
Implicit information
This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(index: Ensuring[Index]).x
Definition Classes
Ensuring
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use resultOfEnsuring instead

class Index extends HtmlPage

Instance Constructors

new Index(universe: Universe, index: doc.Index)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Index, B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

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

final def asInstanceOf[T0]: T0

def blockToHtml(block: Block): NodeSeq

val body: Elem

def bodyToHtml(body: Body): NodeSeq

def browser: Elem

def clone(): AnyRef

def commentToHtml(comment: Comment): NodeSeq

def commentToHtml(comment: Option[Comment]): NodeSeq

def createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream

def description: String

def docEntityKindToBigImage(ety: DocTemplateEntity): String

def ensuring(cond: (Index) ⇒ Boolean, msg: ⇒ Any): Index

def ensuring(cond: (Index) ⇒ Boolean): Index

def ensuring(cond: Boolean, msg: ⇒ Any): Index

def ensuring(cond: Boolean): Index

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hasPage(e: DocTemplateEntity): Boolean

def hashCode(): Int

val headers: Group

val index: doc.Index

def inlineToHtml(inl: Inline): NodeSeq

final def isInstanceOf[T0]: Boolean

def keywords: String

def kindToString(mbr: MemberEntity): String

def letters: NodeSeq

def linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean): NodeSeq

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def packageQualifiedName(ety: DocTemplateEntity): String

def path: collection.immutable.List[String]

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

def relativeLinkTo(destPage: HtmlPage): String

def relativeLinkTo(destClass: TemplateEntity): String

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

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

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

def templatesToHtml(tplss: List[TemplateEntity], sep: NodeSeq): NodeSeq

def title: String

def toString(): String

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

def typeToHtml(tpes: List[TypeEntity], hasLinks: Boolean): NodeSeq

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) ⇒ Unit): Unit

def writeFor(site: HtmlFactory): Unit

def →[B](y: B): (Index, B)

Shadowed Implicit Value Members

val self: Any

val self: Any

Deprecated Value Members

def x: Index

def x: Index

Inherited from HtmlPage

Inherited from Page

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Index to StringAdd

Inherited by implicit conversion any2stringfmt from Index to StringFormat

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