IndexScript

Instance Constructors

new IndexScript(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 IndexScript to StringAdd performed by method any2stringadd in scala.Predef.
Definition Classes
StringAdd
def ->[B](y: B): (IndexScript, B)

Implicit information
This member is added by an implicit conversion from IndexScript to ArrowAssoc[IndexScript] 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
def allPackages: collection.immutable.List[Package]
def allPackagesWithTemplates: Map[Package, collection.immutable.List[DocTemplateEntity]]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream

Definition Classes
Page
def ensuring(cond: (IndexScript) ⇒ Boolean, msg: ⇒ Any): IndexScript

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

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

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

Implicit information
This member is added by an implicit conversion from IndexScript to Ensuring[IndexScript] 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()
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from IndexScript to StringFormat performed by method any2stringfmt in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def kindToString(mbr: MemberEntity): String

Definition Classes
Page
def mergeByQualifiedName(source: List[DocTemplateEntity]): Map[String, List[DocTemplateEntity]]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val packages: JSONObject
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
IndexScript → 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 templateToPath(tpl: TemplateEntity): List[String]

Definition Classes
Page
def toString(): String

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

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

Shadowed Implict Value Members

val self: Any
Implicit information
This member is added by an implicit conversion from IndexScript 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:
(indexScript: StringAdd).self
Definition Classes
StringAdd
val self: Any
Implicit information
This member is added by an implicit conversion from IndexScript 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:
(indexScript: StringFormat).self
Definition Classes
StringFormat

Deprecated Value Members

def x: IndexScript
Implicit information
This member is added by an implicit conversion from IndexScript to ArrowAssoc[IndexScript] 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:
(indexScript: ArrowAssoc[IndexScript]).x
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use leftOfArrow instead
def x: IndexScript
Implicit information
This member is added by an implicit conversion from IndexScript to Ensuring[IndexScript] 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:
(indexScript: Ensuring[IndexScript]).x
Definition Classes
Ensuring
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use resultOfEnsuring instead

class IndexScript extends Page

Instance Constructors

new IndexScript(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): (IndexScript, B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

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

def allPackages: collection.immutable.List[Package]

def allPackagesWithTemplates: Map[Package, collection.immutable.List[DocTemplateEntity]]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

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

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

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

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

def ensuring(cond: Boolean): IndexScript

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def kindToString(mbr: MemberEntity): String

def mergeByQualifiedName(source: List[DocTemplateEntity]): Map[String, List[DocTemplateEntity]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val packages: JSONObject

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 templateToPath(tpl: TemplateEntity): List[String]

def toString(): String

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): (IndexScript, B)

Shadowed Implict Value Members

val self: Any

val self: Any

Deprecated Value Members

def x: IndexScript

def x: IndexScript

Inherited from Page

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from IndexScript to StringAdd

Inherited by implicit conversion any2stringfmt from IndexScript to StringFormat

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

Inherited by implicit conversion any2Ensuring from IndexScript to Ensuring[IndexScript]

Ungrouped