c

scala.tools.partest

ScaladocModelTest

abstract class ScaladocModelTest extends DirectTest

A class for testing scaladoc model generation

  • you need to specify the code in the code method
  • you need to override the testModel method to test the model
  • you may specify extra parameters to send to scaladoc in scaladocSettings
import scala.tools.nsc.doc.model._
import scala.tools.partest.ScaladocModelTest

object Test extends ScaladocModelTest {

  override def code = """ ... """ // or override def resourceFile = "<file>.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")
  }
}
Source
ScaladocModelTest.scala
Linear Supertypes
DirectTest, App, DelayedInit, AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScaladocModelTest
  2. DirectTest
  3. App
  4. DelayedInit
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScaladocModelTest()

Type Members

  1. class TestUnderJavaAtLeast[A] extends AnyRef
    Definition Classes
    DirectTest

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: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest toany2stringadd[ScaladocModelTest] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ScaladocModelTest, B)
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest toArrowAssoc[ScaladocModelTest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def args: Array[String]
    Attributes
    protected
    Definition Classes
    App
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def code: String

    Override to feed code into scaladoc

    Override to feed code into scaladoc

    Definition Classes
    ScaladocModelTestDirectTest
  10. def compilationUnits(global: Global)(sourceCodes: String*): List[nsc.Global.CompilationUnit]
    Definition Classes
    DirectTest
  11. def compile(args: String*): Boolean
    Definition Classes
    DirectTest
  12. def compileString(global: Global)(sourceCode: String): Boolean
    Definition Classes
    DirectTest
  13. def debugSettings: String
    Attributes
    protected
    Definition Classes
    DirectTest
  14. def ensuring(cond: (ScaladocModelTest) => Boolean, msg: => Any): ScaladocModelTest
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest toEnsuring[ScaladocModelTest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (ScaladocModelTest) => Boolean): ScaladocModelTest
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest toEnsuring[ScaladocModelTest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): ScaladocModelTest
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest toEnsuring[ScaladocModelTest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): ScaladocModelTest
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest toEnsuring[ScaladocModelTest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. final val executionStart: Long
    Definition Classes
    App
  21. def extraSettings: String
    Definition Classes
    ScaladocModelTestDirectTest
  22. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  23. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest toStringFormat[ScaladocModelTest] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def isDebug: Boolean

    Debugger interest only below this line *

    Debugger interest only below this line *

    Definition Classes
    ScaladocModelTestDirectTest
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def javaCompilationUnits(global: Global)(sourceCodes: String*): collection.immutable.List[nsc.Global.CompilationUnit]
    Definition Classes
    DirectTest
  29. final def log(msg: => Any): Unit
    Definition Classes
    DirectTest
  30. final def main(args: Array[String]): Unit
    Definition Classes
    App
  31. def model: Option[Universe]
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def newCompiler(settings: Settings): Global
    Definition Classes
    DirectTest
  34. def newCompiler(args: String*): Global
    Definition Classes
    DirectTest
  35. def newDocFactory: DocFactory
  36. def newJavaSources(codes: String*): List[BatchSourceFile]
    Definition Classes
    DirectTest
  37. def newSettings(args: List[String]): Settings
    Definition Classes
    DirectTest
  38. def newSources(codes: String*): List[BatchSourceFile]
    Definition Classes
    DirectTest
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. def reporter(settings: Settings): Reporter
    Definition Classes
    DirectTest
  42. def resourceFile: String

    Override to feed a file in resources to scaladoc

  43. def resourcePath: reflect.io.Directory
  44. def settings: Settings
    Definition Classes
    DirectTest
  45. def show(): Unit
    Definition Classes
    ScaladocModelTestDirectTest
  46. def sourceFilesToCompiledUnits(global: Global)(files: List[SourceFile]): collection.immutable.List[nsc.Global.CompilationUnit]
    Definition Classes
    DirectTest
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def testOutput: reflect.io.Directory
    Definition Classes
    DirectTest
  49. def testPath: reflect.io.File
    Definition Classes
    DirectTest
  50. def testUnderJavaAtLeast[A](version: String)(yesRun: => A): TestUnderJavaAtLeast[A]

    Run a test only if the current java version is at least the version specified.

    Run a test only if the current java version is at least the version specified.

    Definition Classes
    DirectTest
  51. def toString(): String
    Definition Classes
    AnyRef → Any
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  55. def withRun[T](global: Global)(f: (Run) => T): T
    Definition Classes
    DirectTest
  56. object access

Deprecated Value Members

  1. def delayedInit(body: => Unit): Unit
    Definition Classes
    App → DelayedInit
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) the delayedInit mechanism will disappear

  2. def [B](y: B): (ScaladocModelTest, B)
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest toArrowAssoc[ScaladocModelTest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from DirectTest

Inherited from App

Inherited from DelayedInit

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromScaladocModelTest to any2stringadd[ScaladocModelTest]

Inherited by implicit conversion StringFormat fromScaladocModelTest to StringFormat[ScaladocModelTest]

Inherited by implicit conversion Ensuring fromScaladocModelTest to Ensuring[ScaladocModelTest]

Inherited by implicit conversion ArrowAssoc fromScaladocModelTest to ArrowAssoc[ScaladocModelTest]

Ungrouped