scala.tools.nsc.doc.html

Page

class Page extends AnyRef

Attributes
abstract
Self Type
Page
Source
Page.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
HtmlPage, Index, IndexScript, ReferenceIndex, Source, Template
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Page
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Page ()

Abstract Value Members

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

    Attributes
    abstract

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

    Attributes
    abstract

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

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

    Attributes
    final
    Definition Classes
    Any

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

  7. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  8. def clone (): AnyRef

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

  9. def createFileOutputStream (site: HtmlFactory): FileOutputStream

  10. def docEntityKindToString (ety: DocTemplateEntity): String

  11. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  12. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  13. def finalize (): Unit

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

  14. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  15. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  16. def isExcluded (dtpl: DocTemplateEntity): Boolean

  17. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  18. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  19. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  20. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

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

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

  23. def relativeLinkTo (destClass: TemplateEntity): String

    A relative link from this page to some destination class entity.

  24. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

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

  26. def toString (): String

    Definition Classes
    AnyRef → Any

  27. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  29. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any