sxr

Browse

class Browse extends Plugin

The actual work extracting symbols and types is done here.

Attributes
abstract
Linear Supertypes
Plugin, AnyRef, Any
Known Subclasses
BrowsePlugin
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Browse
  2. Plugin
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Browse ()

Abstract Value Members

  1. def classDirectory : File

    Attributes
    abstract

  2. val components : List[PluginComponent]

    Attributes
    abstract
    Definition Classes
    Plugin

  3. val description : String

    Attributes
    abstract
    Definition Classes
    Plugin

  4. def externalLinkURLs : List[URL]

    The URLs of external sxr locations

    The URLs of external sxr locations

    Attributes
    abstract

  5. def getRelativeSourcePath (source: File): String

    Relativizes the path to the given Scala source file against the base directories.

    Relativizes the path to the given Scala source file against the base directories.

    Attributes
    abstract

  6. val global : Global

    The compiler.

    The compiler.

    Attributes
    abstract
    Definition Classes
    Browse → Plugin

  7. val name : String

    Attributes
    abstract
    Definition Classes
    Plugin

  8. def outputFormats : List[OutputFormat]

    The output formats to write

    The output formats to write

    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 asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

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

  8. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  9. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize (): Unit

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

  11. def generateOutput (externalLinks: List[LinkMap]): Unit

    The entry method for invoking the configured writers to generate the output.

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

    Attributes
    final
    Definition Classes
    AnyRef

  13. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  14. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  15. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  16. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  17. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  18. val optionsHelp : Option[String]

    Definition Classes
    Plugin

  19. lazy val outputDirectory : File

  20. def processOptions (options: List[String], error: (String) ⇒ Unit): Unit

    Definition Classes
    Plugin

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

    Attributes
    final
    Definition Classes
    AnyRef

  22. def toString (): String

    Definition Classes
    AnyRef → Any

  23. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  25. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  26. def writeSubDirectoryIndex (f: List[File]): Any

Inherited from Plugin

Inherited from AnyRef

Inherited from Any