scala.tools.nsc.doc.html.page

# Source

#### class Source extends HtmlPage

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

1. Alphabetic
2. By inheritance

Inherited

1. Source
2. HtmlPage
3. Page
4. AnyRef
5. 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 Source(sourceFile: File)

### 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 Source to StringAdd performed by method any2stringadd in scala.Predef.
   Definition Classes
     StringAdd

5. #### def ->[B](y: B): (Source, B)

   Implicit information
     This member is added by an implicit conversion from Source to ArrowAssoc[Source] 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. #### final def asInstanceOf[T0]: T0

   Definition Classes
     Any

10. #### def blockToHtml(block: Block): NodeSeq

    Definition Classes
      HtmlPage

11. #### val body: Elem

    The body of this page.

    The body of this page.

    Definition Classes
      Source → HtmlPage

12. #### def bodyToHtml(body: Body): NodeSeq

    Definition Classes
      HtmlPage

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

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

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

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

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

    Definition Classes
      Page

17. #### def description: String

    The page description

    The page description

    Attributes
      protected
    Definition Classes
      HtmlPage

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

19. #### def ensuring(cond: (Source) ⇒ Boolean, msg: ⇒ Any): Source

    Implicit information
      This member is added by an implicit conversion from Source to Ensuring[Source] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

20. #### def ensuring(cond: (Source) ⇒ Boolean): Source

    Implicit information
      This member is added by an implicit conversion from Source to Ensuring[Source] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

21. #### def ensuring(cond: Boolean, msg: ⇒ Any): Source

    Implicit information
      This member is added by an implicit conversion from Source to Ensuring[Source] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

22. #### def ensuring(cond: Boolean): Source

    Implicit information
      This member is added by an implicit conversion from Source to Ensuring[Source] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

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

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef → Any

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

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

26. #### def formatted(fmtstr: String): String

    Implicit information
      This member is added by an implicit conversion from Source to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

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

    Definition Classes
      AnyRef → Any

28. #### def hasPage(e: DocTemplateEntity): Boolean

    Definition Classes
      HtmlPage

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

    Definition Classes
      AnyRef → Any

30. #### val headers: NodeSeq

    Additional header elements (links, scripts, meta tags, etc.

    Additional header elements (links, scripts, meta tags, etc.) required for this page.

    Definition Classes
      Source → HtmlPage

31. #### def inlineToHtml(inl: Inline): NodeSeq

    Definition Classes
      HtmlPage

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

    Definition Classes
      Any

33. #### def keywords: String

    The page keywords

    The page keywords

    Attributes
      protected
    Definition Classes
      HtmlPage

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

    Definition Classes
      Page

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

    Definition Classes
      HtmlPage

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

    Definition Classes
      HtmlPage

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

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef

40. #### val 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
      Source → Page

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

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

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

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

    Definition Classes
      AnyRef

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

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

    Definition Classes
      Page

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

48. #### val title: String

    The title of this page.

    The title of this page.

    Definition Classes
      Source → HtmlPage

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

    Definition Classes
      AnyRef → Any

50. #### def typeToHtml(tpe: TypeEntity, hasLinks: Boolean): NodeSeq

    Definition Classes
      HtmlPage

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

    Definition Classes
      HtmlPage

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

    Definition Classes
      HtmlPage

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      Page

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

58. #### def →[B](y: B): (Source, B)

    Implicit information
      This member is added by an implicit conversion from Source to ArrowAssoc[Source] 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 Source 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:

         (source: StringAdd).self

   Definition Classes
     StringAdd

2. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from Source 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:

         (source: StringFormat).self

   Definition Classes
     StringFormat

### Deprecated Value Members

1. #### def x: Source

   Implicit information
     This member is added by an implicit conversion from Source to ArrowAssoc[Source] 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:

         (source: ArrowAssoc[Source]).x

   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `leftOfArrow`instead``

2. #### def x: Source

   Implicit information
     This member is added by an implicit conversion from Source to Ensuring[Source] 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:

         (source: Ensuring[Source]).x

   Definition Classes
     Ensuring
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `resultOfEnsuring`instead``

### Inherited from HtmlPage

### Inherited from Page

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from Source to StringAdd

### Inherited by implicit conversion any2stringfmt from Source to StringFormat

### Inherited by implicit conversion any2ArrowAssoc from Source to ArrowAssoc[Source]

### Inherited by implicit conversion any2Ensuring from Source to Ensuring[Source]

### Ungrouped