scala.tools.partest

ScaladocModelTest

abstract class ScaladocModelTest extends DirectTest

A class for testing scaladoc model generation

import scala.tools.nsc.doc.model._
import scala.tools.partest.ScaladocModelTest

object Test extends ScaladocModelTest {

  override def code = """ ... """ // or override def resourceFile = ".scala" (from test/scaladoc/resources)
  def scaladocSettings = " ... "
  def testModel(rootPackage: Package) = {
    // get the quick access implicit defs in scope (_package(s), _class(es), _trait(s), object(s) _method(s), _value(s))
    import access._

    // just need to check the member exists, access methods will throw an error if there's a problem
    rootPackage._package("scala")._package("test")._class("C")._method("foo")
  }
}
Linear Supertypes
DirectTest, App, DelayedInit, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ScaladocModelTest
  2. DirectTest
  3. App
  4. DelayedInit
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringfmt
  2. by any2stringadd
  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 ScaladocModelTest()

Abstract Value Members

  1. abstract def scaladocSettings: String

    Override this to give scaladoc command line parameters

  2. abstract def testModel(root: Package): Unit

    Override this to test the model

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

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

    Implicit information
    This member is added by an implicit conversion from ScaladocModelTest to ArrowAssoc[ScaladocModelTest] 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. object access extends AnyRef

  9. def args: Array[String]

    Attributes
    protected
    Definition Classes
    App

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def clone(): AnyRef

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

  12. def code: String

    Override to feed code into scaladoc

    Override to feed code into scaladoc

    Definition Classes
    ScaladocModelTest → DirectTest

  13. def compilationUnits(global: Global)(sourceCodes: String*): List[CompilationUnit]

    Definition Classes
    DirectTest

  14. def compile(args: String*): Boolean

    Definition Classes
    DirectTest

  15. def compileString(global: Global)(sourceCode: String): Boolean

    Definition Classes
    DirectTest

  16. def debugSettings: String

    Attributes
    protected
    Definition Classes
    DirectTest

  17. def delayedInit(body: ⇒ Unit): Unit

    Definition Classes
    App → DelayedInit

  18. def ensuring(cond: (ScaladocModelTest) ⇒ Boolean, msg: ⇒ Any): ScaladocModelTest

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

  19. def ensuring(cond: (ScaladocModelTest) ⇒ Boolean): ScaladocModelTest

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

  20. def ensuring(cond: Boolean, msg: ⇒ Any): ScaladocModelTest

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

  21. def ensuring(cond: Boolean): ScaladocModelTest

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

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

    Definition Classes
    AnyRef

  23. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  24. val executionStart: Long

    Definition Classes
    App

  25. def extraSettings: String

    Definition Classes
    ScaladocModelTest → DirectTest

  26. def finalize(): Unit

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

  27. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  29. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  30. def isDebug: Boolean

    Debugger interest only below this line *

    Debugger interest only below this line *

    Definition Classes
    ScaladocModelTest → DirectTest

  31. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  32. final def log(msg: ⇒ Any): Unit

    Definition Classes
    DirectTest

  33. def main(args: Array[String]): Unit

    Definition Classes
    App

  34. def model: Option[Universe]

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

    Definition Classes
    AnyRef

  36. def newCompiler(args: String*): Global

    Definition Classes
    DirectTest

  37. def newDocFactory: DocFactory

  38. def newSettings(args: List[String]): Settings

    Definition Classes
    DirectTest

  39. def newSources(sourceCodes: String*): List[BatchSourceFile]

    Definition Classes
    DirectTest

  40. final def notify(): Unit

    Definition Classes
    AnyRef

  41. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  42. def resourceFile: String

    Override to feed a file in resources to scaladoc

  43. def resourcePath: Directory

  44. val self: Any

    Implicit information
    This member is added by an implicit conversion from ScaladocModelTest to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat

  45. val self: Any

    Implicit information
    This member is added by an implicit conversion from ScaladocModelTest to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  46. def show(): Unit

    Definition Classes
    ScaladocModelTest → DirectTest

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

    Definition Classes
    AnyRef

  48. def testOutput: Directory

    Definition Classes
    DirectTest

  49. def testPath: File

    Definition Classes
    DirectTest

  50. def toString(): String

    Definition Classes
    AnyRef → Any

  51. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  54. def withRun[T](global: Global)(f: (Run) ⇒ T): T

    Definition Classes
    DirectTest

  55. def →[B](y: B): (ScaladocModelTest, B)

    Implicit information
    This member is added by an implicit conversion from ScaladocModelTest to ArrowAssoc[ScaladocModelTest] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def x: ScaladocModelTest

    Implicit information
    This member is added by an implicit conversion from ScaladocModelTest to ArrowAssoc[ScaladocModelTest] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ScaladocModelTest

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from DirectTest

Inherited from App

Inherited from DelayedInit

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringfmt from ScaladocModelTest to StringFormat

Inherited by implicit conversion any2stringadd from ScaladocModelTest to StringAdd

Inherited by implicit conversion any2ArrowAssoc from ScaladocModelTest to ArrowAssoc[ScaladocModelTest]

Inherited by implicit conversion any2Ensuring from ScaladocModelTest to Ensuring[ScaladocModelTest]