scala.tools.nsc.doc.html.page

# IndexScript

#### class IndexScript extends Page

Linear Supertypes
Page, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. IndexScript
2. Page
3. AnyRef
4. Any

Implicitly

1. by any2stringadd
2. by any2stringfmt
3. by any2ArrowAssoc
4. by any2Ensuring

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Instance Constructors

1. #### new IndexScript(universe: Universe, index: doc.Index)

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

5. #### 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()

6. #### final def ==(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

7. #### final def ==(arg0: Any): Boolean

   Definition Classes
     Any

8. #### def absoluteLinkTo(path: List[String]): String

   Definition Classes
     Page

9. #### def allPackages: collection.immutable.List[Package]

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

11. #### final def asInstanceOf[T0]: T0

    Definition Classes
      Any

12. #### def clone(): AnyRef

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      Page

14. #### 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

15. #### 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

16. #### 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

17. #### 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

18. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

19. #### def equals(arg0: Any): Boolean

    Definition Classes
      AnyRef → Any

20. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

21. #### 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()

22. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

23. #### def hashCode(): Int

    Definition Classes
      AnyRef → Any

24. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

25. #### def kindToString(mbr: MemberEntity): String

    Definition Classes
      Page

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

27. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

28. #### final def notify(): Unit

    Definition Classes
      AnyRef

29. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

30. #### val packages: JSONObject

31. #### 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

32. #### 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

33. #### 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

34. #### 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

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

    Definition Classes
      AnyRef

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

    Definition Classes
      Page

37. #### def toString(): String

    Definition Classes
      AnyRef → Any

38. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

40. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      Page

42. #### 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

43. #### 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 Implicit Value Members

1. #### 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

2. #### 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

1. #### 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``

2. #### 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``

### 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