scala.tools.nsc.doc.html.page

IndexScript

class IndexScript extends Page

Source
IndexScript.scala
Linear Supertypes
Page, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. IndexScript
  2. Page
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IndexScript(universe: Universe, index: 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. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

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

    Definition Classes
    Page

  7. def allPackages: List[Package]

  8. def allPackagesWithTemplates: Map[Package, List[DocTemplateEntity]]

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def clone(): AnyRef

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

  11. def createFileOutputStream(site: HtmlFactory): FileOutputStream

    Definition Classes
    Page

  12. def docEntityKindToString(ety: DocTemplateEntity): String

    Definition Classes
    Page

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

    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

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

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. def isExcluded(dtpl: DocTemplateEntity): Boolean

    Definition Classes
    Page

  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

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

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. val packages: JSONObject

  25. 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
    IndexScript → Page

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

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

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

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Page

  31. def toString(): String

    Definition Classes
    AnyRef → Any

  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

Inherited from Page

Inherited from AnyRef

Inherited from Any